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

Interface	osid.provisioning.rules.PoolProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.provisioning.rules.PoolProcessorSearchSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods for searching among `PoolProcessor` objects. The search query is constructed using the `PoolProcessorQuery` . 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	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchPoolProcessors
Description	Tests if this user can perform `PoolProcessor` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include pool processors in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPoolProcessorQuery
Description	Gets a pool processor query.
Return	`osid.provisioning.rules.PoolProcessorQuery`		the pool processor query
Compliance	`mandatory`		This method must be implemented.
Method	getPoolProcessorsByQuery
Description	Gets a list of `PoolProcessors` matching the given search.
Parameters	`osid.provisioning.rules.PoolProcessorQuery`	`poolProcessorQuery`	the pool processor query
Return	`osid.provisioning.rules.PoolProcessorList`		a pool processor list
Errors	NULL_ARGUMENT		`poolProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolProcessorQuery` did not originate from `getPoolProcessorQuery()`
Compliance	`mandatory`		This method must be implemented.