OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
messaging package
Version 3.0.0
Release Candidate Preview
| Interface | osid.messaging.MailboxHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getMailboxHierarchyId | ||
| Description |
Gets the hierarchy | ||
| 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 | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyMailboxHierarchy | ||
| Description |
Tests if this user can change the hierarchy. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known performing any
update will result in a | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootMailbox | ||
| Description |
Adds a root mailbox. | ||
| Parameters | osid.id.Id | mailboxId | the Id of a mailbox |
| Errors | ALREADY_EXISTS | mailboxId is already in hierarchy | |
| 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 | removeRootMailbox | ||
| Description |
Remove a root mailbox. | ||
| Parameters | osid.id.Id | mailboxId | the Id of a mailbox |
| Errors | NOT_FOUND | mailboxId is not a root | |
| NULL_ARGUMENT | mailboxId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildMailbox | ||
| Description |
Adds a child to a mailbox. | ||
| Parameters | osid.id.Id | mailboxId | the Id of a mailbox |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | mailboxId is already a parent of childId | |
| NOT_FOUND | mailboxId or childId not found | ||
| NULL_ARGUMENT | mailboxId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildMailbox | ||
| Description |
Removes a child from a mailbox. | ||
| Parameters | osid.id.Id | mailboxId | the Id of a mailbox |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | mailboxId not a parent of childId | |
| NULL_ARGUMENT | mailboxId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildMailboxes | ||
| Description |
Removes all children from a mailbox. | ||
| Parameters | osid.id.Id | mailboxId | the Id of a 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. | |