OSID - osid.provisioning.RequestTransactionSearchSession Service Interface Definition

Interface	osid.provisioning.RequestTransactionSearchSession
Implements	`osid.provisioning.RequestTransactionQuerySession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `RequestTransaction` objects. The search query is constructed using the `RequestTransactionQuery` . `getRequestTransactionsByQuery()` is the basic search method and returns a list of `RequestTransactions` . A more advanced search may be performed with `getRequestTransactionsBySearch()` . It accepts a `RequestTransactionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRequestTransactionsBySearch()` returns a `RequestTransactionSearchResults` that can be used to access the resulting `RequestTransactionList` or be used to perform a search within the result set through `RequestTransactionSearch` .
Method	getRequestTransactionSearch
Description	Gets a request transaction search.
Return	`osid.provisioning.RequestTransactionSearch`		the request transaction search
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionSearchOrder
Description	Gets a request transaction search order. The `RequestTransactionSearchOrder` is supplied to a `RequestTransactionSearch` to specify the ordering of results.
Return	`osid.provisioning.RequestTransactionSearchOrder`		the request transaction search order
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.RequestTransactionQuery`	`requestTransactionQuery`	the request transaction query
Parameters	`osid.provisioning.RequestTransactionSearch`	`requestTransactionSearch`	the request transaction search
Return	`osid.provisioning.RequestTransactionSearchResults`		the request transaction search results
Errors	NULL_ARGUMENT		`requestTransactionQuery` or `requestTransactionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestTransactionQuery` or `requestTransactionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionQueryFromInspector
Description	Gets a request transaction query from an inspector. The inspector is available from a `RequestTransactionSearchResults` .
Parameters	`osid.provisioning.RequestTransactionQueryInspector`	`requestTransactionQueryInspector`	a request transaction query inspector
Return	`osid.provisioning.RequestTransactionQuery`		the request transaction query
Errors	NULL_ARGUMENT		`requestTransactionQueryInspector` is `null`
Errors	UNSUPPORTED		`requestTransactionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.