OSID - osid.messaging.MessageSearchSession Service Interface Definition

Interface	osid.messaging.MessageSearchSession
Implements	`osid.messaging.MessageQuerySession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for searching among `Message` objects. The search query is constructed using the `MessageQuery` . `getMessagesByQuery()` is the basic search method and returns a list of `Messages` . A more advanced search may be performed with `getMessagesBySearch()` .It accepts an `MessageSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getMessagesBySearch()` returns an `MessageSearchResults` that can be used to access the resulting `MessageList` or be used to perform a search within the result set through `MessageList` . This session defines views that offer differing behaviors for searching. federated mailbox view: searches include messages in mailboxes of which this mailbox is a ancestor in the mailbox hierarchy isolated mailbox view: searches are restricted to messages in this mailbox Messages may have a query record indicated by their respective record types. The query record is accessed via the `MessageQuery` .
Method	getMessageSearch
Description	Gets a message search.
Return	`osid.messaging.MessageSearch`		the message search
Compliance	`mandatory`		This method must be implemented.
Method	getMessageSearchOrder
Description	Gets a message search order. The `MessageSearchOrder` is supplied to a `MessageSearch` to specify the ordering of results.
Return	`osid.messaging.MessageSearchOrder`		the message search order
Compliance	`mandatory`		This method must be implemented.
Method	getMessagesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.messaging.MessageQuery`	`messageQuery`	the message query
Parameters	`osid.messaging.MessageSearch`	`messageSearch`	the message search
Return	`osid.messaging.MessageSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`messageQuery` or `messageSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`messageQuery` or `messageSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getMessageQueryFromInspector
Description	Gets a message query from an inspector. The inspector is available from a `MessageSearchResults` .
Parameters	`osid.messaging.MessageQueryInspector`	`messageQueryInspector`	a message query inspector
Return	`osid.messaging.MessageQuery`		the message query
Errors	NULL_ARGUMENT		`messageQueryInspector` is `null`
Errors	UNSUPPORTED		`messageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.