OSID - osid.provisioning.PoolSearchSession Service Interface Definition

Interface	osid.provisioning.PoolSearchSession
Implements	`osid.provisioning.PoolQuerySession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Pool` objects. The search query is constructed using the `PoolQuery` . `getPoolsByQuery()` is the basic search method and returns a list of `Pools` . A more advanced search may be performed with `getPoolsBySearch()` . It accepts a `PoolSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolsBySearch()` returns a `PoolSearchResults` that can be used to access the resulting `PoolList` or be used to perform a search within the result set through `PoolSearch` . This session defines views that offer differing behaviors for searching. federated broker view: searches include pools in brokers of which this broker is an ancestor in the broker hierarchy isolated broker view: searches are restricted to pools in this broker Pools may have a query record indicated by their respective record types. The query record is accessed via the `PoolQuery` .
Method	getPoolSearch
Description	Gets a pool search.
Return	`osid.provisioning.PoolSearch`		the pool search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolSearchOrder
Description	Gets a pool search order. The `PoolSearchOrder` is supplied to a `PoolSearch` to specify the ordering of results.
Return	`osid.provisioning.PoolSearchOrder`		the pool search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.PoolQuery`	`poolQuery`	the pool query
Parameters	`osid.provisioning.PoolSearch`	`poolSearch`	the pool search
Return	`osid.provisioning.PoolSearchResults`		the pool search results
Errors	NULL_ARGUMENT		`poolQuery` or `poolSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolQuery` or `poolSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolQueryFromInspector
Description	Gets a pool query from an inspector. The inspector is available from a `PoolSearchResults` .
Parameters	`osid.provisioning.PoolQueryInspector`	`poolQueryInspector`	a pool query inspector
Return	`osid.provisioning.PoolQuery`		the pool query
Errors	NULL_ARGUMENT		`poolQueryInspector` is `null`
Errors	UNSUPPORTED		`poolQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.