OSID - osid.messaging.MailboxSearchSession Service Interface Definition

Interface	osid.messaging.MailboxSearchSession
Implements	`osid.messaging.MailboxQuerySession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for searching among `Mailbox` objects. The search query is constructed using the `MailboxQuery` . `getMailboxesByQuery()` is the basic search method and returns a list of `Mailbox` objects.A more advanced search may be performed with `getMailboxesBySearch()` .It accepts a `MailboxSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getMailboxesBySearch()` returns a `MailboxSearchResults` that can be used to access the resulting `MailboxList` or be used to perform a search within the result set through `MailboxSearch` . Mailboxes may have a query record indicated by their respective record types. The query record is accessed via the `MailboxQuery` .
Method	getMailboxSearch
Description	Gets a mailbox search.
Return	`osid.messaging.MailboxSearch`		the mailbox search
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxSearchOrder
Description	Gets a mailbox search order. The `MailboxSearchOrder` is supplied to a `MailboxSearch` to specify the ordering of results.
Return	`osid.messaging.MailboxSearchOrder`		the mailbox search order
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.messaging.MailboxQuery`	`mailboxQuery`	the mailbox query
Parameters	`osid.messaging.MailboxSearch`	`mailboxSearch`	the mailbox search
Return	`osid.messaging.MailboxSearchResults`		the mailbox search results
Errors	NULL_ARGUMENT		`mailboxQuery` or `mailboxSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`mailboxQuery` or `mailboxSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxQueryFromInspector
Description	Gets a mailbox query from an inspector. The inspector is available from a `MailboxSearchResults` .
Parameters	`osid.messaging.MailboxQueryInspector`	`mailboxQueryInspector`	a mailbox query inspector
Return	`osid.messaging.MailboxQuery`		the mailbox query
Errors	NULL_ARGUMENT		`mailboxQueryInspector` is `null`
Errors	UNSUPPORTED		`mailboxQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.