OSID - osid.provisioning.rules.PoolConstrainerSearchSession Service Interface Definition

Interface	osid.provisioning.rules.PoolConstrainerSearchSession
Implements	`osid.provisioning.rules.PoolConstrainerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolConstrainers` . The search query is constructed using the `PoolConstrainerQuery` . `getPoolConstrainersByQuery()` is the basic search method and returns a list of `PoolConstrainers` . A more advanced search may be performed with `getPoolConstrainersBySearch()` . It accepts a `PoolConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolConstrainersBySearch()` returns a `PoolConstrainerSearchResults` that can be used to access the resulting `PoolConstrainerList` or be used to perform a search within the result set through Po `olConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include pool constrainers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to pool constrainers in this distributor Pool constrainers may have a query record indicated by their respective record types. The query record is accessed via the `PoolConstrainerQuery` .
Method	getPoolConstrainerSearch
Description	Gets a pool constrainer search.
Return	`osid.provisioning.rules.PoolConstrainerSearch`		the pool constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerSearchOrder
Description	Gets a pool constrainer search order. The `PoolConstrainerSearchOrder` is supplied to a `PoolConstrainerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.PoolConstrainerSearchOrder`		the pool constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.PoolConstrainerQuery`	`poolConstrainerQuery`	the pool constrainer query
Parameters	`osid.provisioning.rules.PoolConstrainerSearch`	`poolConstrainerSearch`	the pool constrainer search
Return	`osid.provisioning.rules.PoolConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`poolConstrainerQuery` or `poolConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolConstrainerQuery` or `poolConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerQueryFromInspector
Description	Gets a pool constrainer query from an inspector. The inspector is available from a `PoolConstrainerSearchResults` .
Parameters	`osid.provisioning.rules.PoolConstrainerQueryInspector`	`poolConstrainerQueryInspector`	a pool constrainer query inspector
Return	`osid.provisioning.rules.PoolConstrainerQuery`		the pool constrainer query
Errors	NULL_ARGUMENT		`poolConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.