OSID - osid.messaging.MailboxSearch Service Interface Definition

Interface	osid.messaging.MailboxSearch
Implements	`osid.OsidSearch`
Description	The interface for governing mailbox searches.
Method	searchAmongMailboxes
Description	Execute this search among the given list of mailboxes.
Parameters	`osid.id.IdList`	`mailboxIds`	list of mailboxes
Errors	NULL_ARGUMENT		`mailboxIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderMailboxResults
Description	Specify an ordering to the search results.
Parameters	`osid.messaging.MailboxSearchOrder`	`mailboxSearchOrder`	mailbox search order
Errors	NULL_ARGUMENT		`mailboxSearchOrder` is `null`
Errors	UNSUPPORTED		`mailboxSearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxSearchRecord
Description	Gets the mailbox search record corresponding to the given mailbox search record `Type.` This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.
Parameters	`osid.type.Type`	`mailboxSearchRecordType`	a mailbox search record type
Return	`osid.messaging.records.MailboxSearchRecord`		the mailbox search record
Errors	NULL_ARGUMENT		`mailboxSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(mailboxSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.