OSID - osid.messaging.ReceiptSearchSession Service Interface Definition

Interface	osid.messaging.ReceiptSearchSession
Implements	`osid.messaging.ReceiptQuerySession`
Used By	`osid.messaging.MessagingManager`
Used By	`osid.messaging.MessagingProxyManager`
Description	This session provides methods for searching among `Receipt` objects. The search query is constructed using the `ReceiptQuery`. `getReceiptsByQuery()` is the basic search method and returns a list of `Receipts`. A more advanced search may be performed with `getReceiptsBySearch()`.It accepts an `ReceiptSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getReceiptsBySearch()` returns an `ReceiptSearchResults` that can be used to access the resulting `ReceiptList` or be used to perform a search within the result set through `ReceiptList`. This session defines views that offer differing behaviors for searching. federated mailbox view: searches include receipts in mailboxes of which this mailbox is a ancestor in the mailbox hierarchy isolated mailbox view: searches are restricted to receipts in this mailbox Receipts may have a query record indicated by their respective record types. The query record is accessed via the `ReceiptQuery`. Like all `OsidSessions`, `ReceiptSearchSessions` are dedicated to single processing threads and a single authenticated user.
Method	getReceiptSearch
Description	Gets a receipt search.
Return	`osid.messaging.ReceiptSearch`		the receipt search
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptSearchOrder
Description	Gets a receipt search order. The `ReceiptSearchOrder` is supplied to a `ReceiptSearch` to specify the ordering of results.
Return	`osid.messaging.ReceiptSearchOrder`		the receipt search order
Compliance	`mandatory`		This method must be implemented.
Method	getReceiptsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.messaging.ReceiptQuery`	`messageQuery`	the receipt query
Parameters	`osid.messaging.ReceiptSearch`	`messageSearch`	the receipt search
Return	`osid.messaging.ReceiptSearchResults`		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	getReceiptQueryFromInspector
Description	Gets a receipt query from an inspector. The inspector is available from a `ReceiptSearchResults`.
Parameters	`osid.messaging.ReceiptQueryInspector`	`messageQueryInspector`	a receipt query inspector
Return	`osid.messaging.ReceiptQuery`		the receipt query
Errors	NULL_ARGUMENT		`messageQueryInspector` is `null`
Errors	UNSUPPORTED		`messageQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.