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

Interface	osid.provisioning.rules.PoolProcessorSearchSession
Implements	`osid.provisioning.rules.PoolProcessorQuerySession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolProcessors` . The search query is constructed using the `PoolProcessorQuery` . `getPoolProcessorsByQuery()` is the basic search method and returns a list of `PoolProcessors` . A more advanced search may be performed with `getPoolProcessorsBySearch()` .It accepts a `PoolProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPoolProcessorsBySearch()` returns a `PoolProcessorSearchResults` that can be used to access the resulting `PoolProcessorList` or be used to perform a search within the result set through Poo `lProcessorSearch` . This session defines views that offer differing behaviors for searching. federated distributor view: searches include pool processors in distributors of which this distributor is an ancestor in the distributor hierarchy isolated distributor view: searches are restricted to pool processors in this distributor Pool processors may have a query record indicated by their respective record types. The query record is accessed via the `PoolProcessorQuery` .
Method	getPoolProcessorSearch
Description	Gets a pool processor search.
Return	`osid.provisioning.rules.PoolProcessorSearch`		the pool processor search
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorSearchOrder
Description	Gets a pool processor search order. The `PoolProcessorSearchOrder` is supplied to a `PoolProcessorSearch` to specify the ordering of results.
Return	`osid.provisioning.rules.PoolProcessorSearchOrder`		the pool processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.provisioning.rules.PoolProcessorQuery`	`poolProcessorQuery`	the pool processor query
Parameters	`osid.provisioning.rules.PoolProcessorSearch`	`poolProcessorSearch`	the pool processor search
Return	`osid.provisioning.rules.PoolProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`poolProcessorQuery` or `poolProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorQuery` or `poolProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorQueryFromInspector
Description	Gets a pool processor query from an inspector. The inspector is available from a `PoolProcessorSearchResults` .
Parameters	`osid.provisioning.rules.PoolProcessorQueryInspector`	`poolProcessorQueryInspector`	a pool processor query inspector
Return	`osid.provisioning.rules.PoolProcessorQuery`		the pool processor query
Errors	NULL_ARGUMENT		`poolProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`poolProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.