Interface | osid.messaging.MailboxLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. For example, a browsing application
may only need to examine the Mailboxes may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
Method | canLookupMailboxes | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeMailboxView | ||
Description |
The returns from the lookup 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 | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getMailbox | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mailboxId | Id of the Mailbox |
Return | osid.messaging.Mailbox | 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 is must be implemented. | |
Method | getMailboxesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | mailboxIds | the list of Ids to retrieve |
Return | osid.messaging.MailboxList | the returned Mailbox list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | mailboxIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | mailboxGenusType | a mailbox genus type |
Return | osid.messaging.MailboxList | the returned Mailbox list | |
Errors | NULL_ARGUMENT | mailboxGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | mailboxGenusType | a mailbox genus type |
Return | osid.messaging.MailboxList | the returned Mailbox list | |
Errors | NULL_ARGUMENT | mailboxGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | mailboxRecordType | a mailbox record type |
Return | osid.messaging.MailboxList | the returned Mailbox list | |
Errors | NULL_ARGUMENT | mailboxRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxesByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.messaging.MailboxList | the returned Mailbox list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxes | ||
Description |
Gets all | ||
Return | osid.messaging.MailboxList | a list of mailboxes | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |