OSID - osid.provisioning.RequestSearchSession Service Interface Definition

Interface	osid.provisioning.RequestSearchSession
Implements	`osid.provisioning.RequestQuerySession`
Description	This session provides methods for searching among `Request` objects. The search query is constructed using the `RequestQuery.` `getRequestsByQuery()` is the basic search method and returns a list of `Requests.` A more advanced search may be performed with `getRequestsBySearch().` It accepts a `RequestSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRequestsBySearch()` returns a `RequestSearchResults` that can be used to access the resulting `RequestList` or be used to perform a search within the result set through `RequestSearch.` This session defines views that offer differing behaviors for searching. federated distributor view: searches include requests in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to requests in this distributor Requests may have a query record indicated by their respective record types. The query record is accessed via the `RequestQuery.`
Method	getRequestSearch
Description	Gets a request search.
Return	`osid.provisioning.RequestSearch`		the request search
Compliance	`mandatory`		This method must be implemented.
Method	getRequestSearchOrder
Description	Gets a request search order. The `RequestSearchOrder` is supplied to a `RequestSearch` to specify the ordering of results.
Return	`osid.provisioning.RequestSearchOrder`		the request search order
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.RequestQuery`	`requestQuery`	the request query
Parameters	`osid.provisioning.RequestSearch`	`requestSearch`	the request search
Return	`osid.provisioning.RequestSearchResults`		the request search results
Errors	NULL_ARGUMENT		`requestQuery` or `requestSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`requestQuery` or `requestSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequestQueryFromInspector
Description	Gets a request query from an inspector. The inspector is available from a `RequestSearchResults.`
Parameters	`osid.provisioning.RequestQueryInspector`	`requestQueryInspector`	a request query inspector
Return	`osid.provisioning.RequestQuery`		the request query
Errors	NULL_ARGUMENT		`requestQueryInspector` is `null`
Errors	UNSUPPORTED		`requestQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.