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

Interface	osid.provisioning.rules.PoolConstrainerEnablerSearchSession
Implements	`osid.provisioning.rules.PoolConstrainerEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolConstrainerEnablers` . The search query is constructed using the `PoolConstrainerEnablerQuery` . `getPoolConstrainerEnablersByQuery()` is the basic search method and returns a list of `PoolConstrainerEnablers` . A more advanced search may be performed with `getPoolConstrainerEnablersBySearch()` .It accepts a `PoolConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolConstrainerEnablersBySearch()` returns a `PoolConstrainerEnablerSearchResults` that can be used to access the resulting `PoolConstrainerEnablerList` or be used to perform a search within the result set through Po `olConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include pool constrainer enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to pool constrainer enablers in this distributor Pool constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the `PoolConstrainerEnablerQuery` .
Method	getPoolConstrainerEnablerSearch
Description	Gets a pool constrainer enabler search.
Return	`osid.provisioning.rules.PoolConstrainerEnablerSearch`		the pool constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerEnablerSearchOrder
Description	Gets a pool constrainer enabler search order. The `PoolConstrainerEnablerSearchOrder` is supplied to a `PoolConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.PoolConstrainerEnablerSearchOrder`		the pool constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.PoolEnablerQuery`	`poolConstrainerEnablerQuery`	the pool constrainer enabler query
Parameters	`osid.provisioning.rules.PoolConstrainerEnablerSearch`	`poolConstrainerEnablerSearch`	the pool constrainer enabler search
Return	`osid.provisioning.rules.PoolConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`poolConstrainerEnablerQuery` or `poolConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolConstrainerEnablerQuery` or `poolConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerEnablerQueryFromInspector
Description	Gets a pool constrainer enabler query from an inspector. The inspector is available from a `PoolConstrainerEnablerSearchResults` .
Parameters	`osid.provisioning.rules.PoolConstrainerEnablerQueryInspector`	`poolConstrainerEnablerQueryInspector`	a pool constrainer enabler query inspector
Return	`osid.provisioning.rules.PoolConstrainerEnablerQuery`		the pool constrainer enabler query
Errors	NULL_ARGUMENT		`poolConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.