OSID - osid.messaging.MailboxHierarchySession Service Interface Definition

Interface	osid.messaging.MailboxHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session defines methods for traversing a hierarchy of `Mailbox` objects. Each node in the hierarchy is a unique `Mailbox`. The hierarchy may be traversed recursively to establish the tree structure through `getParentMailboxes()` and `getChildMailboxes()`. To relate these `Ids` to another OSID, `getMailboxNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Mailbox` available in the Mailbox OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node. A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of `getParentMailboxes()` or `getChildMailboxes()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized pathways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: mailbox elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getMailboxHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessMailboxHierarchy
Description	Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeMailboxView
Description	The returns from the mailbox methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryMailboxView
Description	A complete view of the `Mailbox` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootMailboxIds
Description	Gets the root mailbox `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root mailbox `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootMailboxes
Description	Gets the root mailboxes in the mailbox hierarchy. A node with no parents is an orphan. While all mailbox `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.messaging.MailboxList`		the root mailboxes
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentMailboxes
Description	Tests if the `Mailbox` has any parents.
Parameters	`osid.id.Id`	`mailboxId`	a mailbox `Id`
Return	`boolean`		`true` if the mailbox has parents, `false` otherwise
Errors	NOT_FOUND		`mailboxId` is not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfMailbox
Description	Tests if an `Id` is a direct parent of a mailbox.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mailboxId`	a mailbox `Id`
Return	`boolean`		`true` if this `id` is a parent of `mailboxId`, `false` otherwise
Errors	NOT_FOUND		`mailboxId` is not found
	NULL_ARGUMENT		`id` or `mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	getParentMailboxIds
Description	Gets the parent `Ids` of the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	a mailbox `Id`
Return	`osid.id.IdList`		the parent `Ids` of the mailbox
Errors	NOT_FOUND		`mailboxId` is not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentMailboxes
Description	Gets the parents of the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` to query
Return	`osid.messaging.MailboxList`		the parents of the mailbox
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfMailbox
Description	Tests if an `Id` is an ancestor of a mailbox.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of a mailbox
Return	`boolean`		`true` if this `id` is an ancestor of `mailboxId`, `false` otherwise
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	hasChildMailboxes
Description	Tests if a mailbox has any children.
Parameters	`osid.id.Id`	`mailboxId`	a `mailboxId`
Return	`boolean`		`true` if the `mailboxId` has children, `false` otherwise
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfMailbox
Description	Tests if a mailbox is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of a mailbox
Return	`boolean`		`true` if the `id` is a child of `mailboxId`, `false` otherwise
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	getChildMailboxIds
Description	Gets the child `Ids` of the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` to query
Return	`osid.id.IdList`		the children of the mailbox
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildMailboxes
Description	Gets the children of the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` to query
Return	`osid.messaging.MailboxList`		the children of the mailbox
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfMailbox
Description	Tests if an `Id` is a descendant of a mailbox.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`mailboxId`	the `Id` of a mailbox
Return	`boolean`		`true` if the `id` is a descendant of the `mailboxId`, `false` otherwise
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false`.
Method	getMailboxNodeIds
Description	Gets a portion of the hierarchy for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a mailbox node
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxNodes
Description	Gets a portion of the hierarchy for the given mailbox.
Parameters	`osid.id.Id`	`mailboxId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.messaging.MailboxNode`		a mailbox node
Errors	NOT_FOUND		`mailboxId` not found
	NULL_ARGUMENT		`mailboxId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.