OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxHierarchySession
Implementsosid.OsidSession
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
MethodgetMailboxHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMailboxHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessMailboxHierarchy
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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeMailboxView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryMailboxView
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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootMailboxIds
Description

Gets the root mailbox Ids in this hierarchy.

Returnosid.id.IdListthe root mailbox Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootMailboxes
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.

Returnosid.messaging.MailboxListthe root mailboxes
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentMailboxes
Description

Tests if the Mailbox has any parents.

Parametersosid.id.IdmailboxIda mailbox Id
Returnboolean true if the mailbox has parents, false otherwise
ErrorsNOT_FOUND mailboxId is not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfMailbox
Description

Tests if an Id is a direct parent of a mailbox.

Parametersosid.id.Ididan Id
osid.id.IdmailboxIda mailbox Id
Returnboolean true if this id is a parent of mailboxId, false otherwise
ErrorsNOT_FOUND mailboxId is not found
NULL_ARGUMENT id or mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentMailboxIds
Description

Gets the parent Ids of the given mailbox.

Parametersosid.id.IdmailboxIda mailbox Id
Returnosid.id.IdListthe parent Ids of the mailbox
ErrorsNOT_FOUND mailboxId is not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentMailboxes
Description

Gets the parents of the given mailbox.

Parametersosid.id.IdmailboxIdthe Id to query
Returnosid.messaging.MailboxListthe parents of the mailbox
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfMailbox
Description

Tests if an Id is an ancestor of a mailbox.

Parametersosid.id.Ididan Id
osid.id.IdmailboxIdthe Id of a mailbox
Returnboolean true if this id is an ancestor of mailboxId, false otherwise
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildMailboxes
Description

Tests if a mailbox has any children.

Parametersosid.id.IdmailboxIda mailboxId
Returnboolean true if the mailboxId has children, false otherwise
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfMailbox
Description

Tests if a mailbox is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdmailboxIdthe Id of a mailbox
Returnboolean true if the id is a child of mailboxId, false otherwise
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildMailboxIds
Description

Gets the child Ids of the given mailbox.

Parametersosid.id.IdmailboxIdthe Id to query
Returnosid.id.IdListthe children of the mailbox
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildMailboxes
Description

Gets the children of the given mailbox.

Parametersosid.id.IdmailboxIdthe Id to query
Returnosid.messaging.MailboxListthe children of the mailbox
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfMailbox
Description

Tests if an Id is a descendant of a mailbox.

Parametersosid.id.Ididan Id
osid.id.IdmailboxIdthe Id of a mailbox
Returnboolean true if the id is a descendant of the mailboxId, false otherwise
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetMailboxNodeIds
Description

Gets a portion of the hierarchy for the given mailbox.

Parametersosid.id.IdmailboxIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea mailbox node
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxNodes
Description

Gets a portion of the hierarchy for the given mailbox.

Parametersosid.id.IdmailboxIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.messaging.MailboxNodea mailbox node
ErrorsNOT_FOUND mailboxId not found
NULL_ARGUMENT mailboxId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.