OSID - osid.provisioning.ProvisionSearchSession Service Interface Definition

Interface	osid.provisioning.ProvisionSearchSession
Implements	`osid.provisioning.ProvisionQuerySession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Provision` objects. The search query is constructed using the `ProvisionQuery` . `getProvisionsByQuery()` is the basic search method and returns a list of `Provisions` . A more advanced search may be performed with `getProvisionsBySearch()` .It accepts a `ProvisionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProvisionsBySearch()` returns a `ProvisionSearchResults` that can be used to access the resulting `ProvisionList` or be used to perform a search within the result set through `ProvisionSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include provisions in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to provisions in this distributor Provisions may have a record indicated by their respective record types. The query record is accessed via the `ProvisionQuery` .
Method	getProvisionSearch
Description	Gets a provision search.
Return	`osid.provisioning.ProvisionSearch`		the provision search
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionSearchOrder
Description	Gets a provision search order. The `ProvisionSearchOrder` is supplied to a `ProvisionSearch` to specify the ordering of results.
Return	`osid.provisioning.ProvisionSearchOrder`		the provision search order
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.ProvisionQuery`	`provisionQuery`	the provision query
Parameters	`osid.provisioning.ProvisionSearch`	`provisionSearch`	the provision search
Return	`osid.provisioning.ProvisionSearchResults`		the provision search results
Errors	NULL_ARGUMENT		`provisionQuery` or `provisionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`provisionQuery` or `provisionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionQueryFromInspector
Description	Gets a provision query from an inspector. The inspector is available from a `ProvisionSearchResults` .
Parameters	`osid.provisioning.ProvisionQueryInspector`	`provisionQueryInspector`	a provision query inspector
Return	`osid.provisioning.ProvisionQuery`		the provision query
Errors	NULL_ARGUMENT		`provisionQueryInspector` is `null`
Errors	UNSUPPORTED		`provisionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.