OSID - osid.provisioning.ProvisionableSearchSession Service Interface Definition

Interface	osid.provisioning.ProvisionableSearchSession
Implements	`osid.provisioning.ProvisionableQuerySession`
Description	This session provides methods for searching among `Provisionable` objects. The search query is constructed using the `ProvisionableQuery` . `getProvisionablesByQuery()` is the basic search method and returns a list of `Provisionables` . A more advanced search may be performed with `getProvisionablesBySearch()` .It accepts an `ProvisionableSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProvisionablesBySearch()` returns an `ProvisionableSearchResults` that can be used to access the resulting `ProvisionableList` or be used to perform a search within the result set through `ProvisionableSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include provisionables in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to provisionables in this distributor Provisionables may have a query record indicated by their respective record types. The query record is accessed via the `ProvisionableQuery` .
Method	getProvisionableSearch
Description	Gets a provisionable search.
Return	`osid.provisioning.ProvisionableSearch`		the provisionable search
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableSearchOrder
Description	Gets a provisionable search order. The `ProvisionableSearchOrder` is supplied to a `ProvisionableSearch` to specify the ordering of results.
Return	`osid.provisioning.ProvisionableSearchOrder`		the provisionable search order
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionablesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.ProvisionableQuery`	`provisionableQuery`	the provisionable query
Parameters	`osid.provisioning.ProvisionableSearch`	`provisionableSearch`	the provisionable search
Return	`osid.provisioning.ProvisionableSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`provisionableQuery` or `provisionableSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionableQuery` or `provisionableSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionableQueryFromInspector
Description	Gets a provisionable query from an inspector. The inspector is available from a `ProvisionableSearchResults` .
Parameters	`osid.provisioning.ProvisionableQueryInspector`	`provisionableQueryInspector`	a provisionable query inspector
Return	`osid.provisioning.ProvisionableQuery`		the provisionable query
Errors	NULL_ARGUMENT		`provisionableQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionableQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.