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

Interface	osid.provisioning.rules.PoolEnablerSearchSession
Implements	`osid.provisioning.rules.PoolEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolEnablers` . The search query is constructed using the `PoolEnablerQuery` . `getPoolEnablersByQuery()` is the basic search method and returns a list of `PoolEnablers` . A more advanced search may be performed with `getPoolEnablersBySearch()` .It accepts a `PoolEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolEnablersBySearch()` returns a `PoolEnablerSearchResults` that can be used to access the resulting `PoolEnablerList` or be used to perform a search within the result set through Poo `lEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include pool enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to pool enablers in this distributor Pool enablers may have a query record indicated by their respective record types. The query record is accessed via the `PoolEnablerQuery` .
Method	getPoolEnablerSearch
Description	Gets a pool enabler search.
Return	`osid.provisioning.rules.PoolEnablerSearch`		the pool enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolEnablerSearchOrder
Description	Gets a pool enabler search order. The `PoolEnablerSearchOrder` is supplied to a `PoolEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.PoolEnablerSearchOrder`		the pool enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.PoolEnablerQuery`	`poolEnablerQuery`	the pool enabler query
Parameters	`osid.provisioning.rules.PoolEnablerSearch`	`poolEnablerSearch`	the pool enabler search
Return	`osid.provisioning.rules.PoolEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`poolEnablerQuery` or `poolEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolEnablerQuery` or `poolEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolEnablerQueryFromInspector
Description	Gets a pool enabler query from an inspector. The inspector is available from a `PoolEnablerSearchResults` .
Parameters	`osid.provisioning.rules.PoolEnablerQueryInspector`	`poolEnablerQueryInspector`	a pool enabler query inspector
Return	`osid.provisioning.rules.PoolEnablerQuery`		the pool enabler query
Errors	NULL_ARGUMENT		`poolEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.