OSID - osid.messaging.MessageMailboxSession Service Interface Definition

Interface	osid.messaging.MessageMailboxSession
Implements	`osid.OsidSession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods to retrieve `Message` to `Mailbox` mappings. A `Message` may appear in multiple `Mailboxes`. Each `Mailbox` may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupMessageMailboxMappings
Description	Tests if this user can perform lookups of message/mailbox mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is 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 `Message` and `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	getMessageIdsByMailbox
Description	Gets the list of `Message` `Ids` associated with a `Mailbox`.
Parameters	`osid.id.Id`	`mailboxId`	`Id` of a `Mailbox`
Return	`osid.id.IdList`		list of related message `Ids`
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	getMessagesByMailbox
Description	Gets the list of `Messages` associated with a `Mailbox`.
Parameters	`osid.id.Id`	`mailboxId`	`Id` of a `Mailbox`
Return	`osid.messaging.MessageList`		list of related messages
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	getMessageIdsByMailboxes
Description	Gets the list of `Message Ids` corresponding to a list of `Mailbox` objects.
Parameters	`osid.id.IdList`	`mailboxIds`	list of mailbox `Ids`
Return	`osid.id.IdList`		list of message `Ids`
Errors	NULL_ARGUMENT		`mailboxIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesByMailboxes
Description	Gets the list of `Messages` corresponding to a list of `Mailboxes`.
Parameters	`osid.id.IdList`	`mailboxIds`	list of mailbox `Ids`
Return	`osid.messaging.MessageList`		list of messages
Errors	NULL_ARGUMENT		`mailboxIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxIdsByMessage
Description	Gets the list of `Mailbox` `Ids` mapped to a `Message`.
Parameters	`osid.id.Id`	`messageId`	`Id` of a `Message`
Return	`osid.id.IdList`		list of mailbox `Ids`
Errors	NOT_FOUND		`messageId` is not found
	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxesByMessage
Description	Gets the list of `Mailbox` objects mapped to a `Message`.
Parameters	`osid.id.Id`	`messageId`	`Id` of a `Message`
Return	`osid.messaging.MailboxList`		list of mailboxes
Errors	NOT_FOUND		`messageId` is not found
	NULL_ARGUMENT		`messageId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.