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

Interface	osid.provisioning.rules.PoolProcessorEnablerSearchSession
Implements	`osid.provisioning.rules.PoolProcessorEnablerQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolProcessorEnablers` . The search query is constructed using the `PoolProcessorEnablerQuery` . `getPoolProcessorEnablersByQuery()` is the basic search method and returns a list of `PoolProcessorEnablers` . A more advanced search may be performed with `getPoolProcessorEnablersBySearch()` . It accepts a `PoolProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolProcessorEnablersBySearch()` returns a `PoolProcessorEnablerSearchResults` that can be used to access the resulting `PoolProcessorEnablerList` or be used to perform a search within the result set through Po `olProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include pool processor enablers in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to pool processor enablers in this distributor Pool processor enablers may have a query record indicated by their respective record types. The query record is accessed via the `PoolProcessorEnablerQuery` .
Method	getPoolProcessorEnablerSearch
Description	Gets a pool processor enabler search.
Return	`osid.provisioning.rules.PoolProcessorEnablerSearch`		the pool processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablerSearchOrder
Description	Gets a pool processor enabler search order. The `PoolProcessorEnablerSearchOrder` is supplied to a `PoolProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.PoolProcessorEnablerSearchOrder`		the pool processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.PoolProcessorEnablerQuery`	`poolProcessorEnablerQuery`	the pool processor enabler query
Parameters	`osid.provisioning.rules.PoolProcessorEnablerSearch`	`poolProcessorEnablerSearch`	the pool processor enabler search
Return	`osid.provisioning.rules.PoolProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`poolProcessorEnablerQuery` or `poolProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorEnablerQuery` or `poolProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorEnablerQueryFromInspector
Description	Gets a pool processor enabler query from an inspector. The inspector is available from a `PoolProcessorEnablerSearchResults` .
Parameters	`osid.provisioning.rules.PoolProcessorEnablerQueryInspector`	`poolProcessorEnablerQueryInspector`	a pool processor enabler query inspector
Return	`osid.provisioning.rules.PoolProcessorEnablerQuery`		the pool processor enabler query
Errors	NULL_ARGUMENT		`poolProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.