OSID - osid.messaging.MailboxLookupSession Service Interface Definition

Interface	osid.messaging.MailboxLookupSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for retrieving `Mailbox` objects. The `Mailbox` represents a collection messages. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition 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` it can access, without breaking execution. However, an administrative application may require all `Mailbox` elements to be available. Mailboxes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Mailbox`.
Method	canLookupMailboxes
Description	Tests if this user can perform `Mailbox` lookups. 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 to unauthorized users.
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 `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	getMailbox
Description	Gets the `Mailbox` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Mailbox` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Mailbox` and retained for compatibility.
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 `MailboxLidt` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the mailboxes specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible mailboxes may be omitted from the list and may present the elements in any order including returning a unique set.
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 `Mailbox` corresponding to the given mailbox genus `Type` which does not include mailboxes of types derived from the specified `Type`. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
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 `MailboxList` corresponding to the given psocess genus `Type` and include any additional mailboxes with genus types derived from the specified `Type`.In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
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 `MailboxList` containing the given mailbox record `Type`. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
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 `MailboxList` for the given provider. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
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 `Mailboxes`. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
Return	`osid.messaging.MailboxList`		a list of mailboxes
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.