OSID - osid.messaging.MailboxQuerySession Service Interface Definition

Interface	osid.messaging.MailboxQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Mailbox` objects. The search query is constructed using the `MailboxQuery.` Mailboxes may have a query record indicated by their respective record types. The query record is accessed via the `MailboxQuery.`
Method	canSearchMailboxes
Description	Tests if this user can perform `Mailbox` searches. 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 search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxQuery
Description	Gets a mailbox query.
Return	`osid.messaging.MailboxQuery`		the mailbox query
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxesByQuery
Description	Gets a list of `Mailboxes` matching the given mailbox query.
Parameters	`osid.messaging.MailboxQuery`	`mailboxQuery`	the mailbox query
Return	`osid.messaging.MailboxList`		the returned `MailboxList`
Errors	NULL_ARGUMENT		`mailboxQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		a `mailboxQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.