OSID - osid.messaging.MailboxSearchResults Service Interface Definition

Interface	osid.messaging.MailboxSearchResults
Implements	`osid.OsidSearchResults`
Used By	`osid.messaging.MailboxSearchSession`
Description	This interface provides a means to capture results of a search.
Method	getMailboxes
Description	Gets the mailbox list resulting from the search.
Return	`osid.messaging.MailboxList`		the mailbox list
Errors	ILLEGAL_STATE		list already retrieved
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxQueryInspector
Description	Gets the inspector for the query to examine the terms used in the search.
Return	`osid.messaging.MailboxQueryInspector`		the mailbox query inspector
Compliance	`mandatory`		This method must be implemented.
Method	getMailboxSearchResultsRecord
Description	Gets the mailbox search results 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.MailboxSearchResultsRecord`		the mailbox search results 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.