OSID - osid.provisioning.PoolQuerySession Service Interface Definition

Interface	osid.provisioning.PoolQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.provisioning.PoolSearchSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session provides methods for searching among `Pool` objects. The search query is constructed using the `PoolQuery`. This session defines views that offer differing behaviors for searching. federated broker view: searches include pools in brokers of which this broker is an ancestor in the broker hierarchy isolated broker view: searches are restricted to pools in this broker Pools may have a query record indicated by their respective record types. The query record is accessed via the `PoolQuery`.
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	canSearchPools
Description	Tests if this user can perform `Pool` lookups. 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 pools in distributors which are children of this broker 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 lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPoolQuery
Description	Gets a pool query.
Return	`osid.provisioning.PoolQuery`		the pool query
Compliance	`mandatory`		This method must be implemented.
Method	getPoolsByQuery
Description	Gets a list of `Pools` matching the given pool query.
Parameters	`osid.provisioning.PoolQuery`	`poolQuery`	the pool query
Return	`osid.provisioning.PoolList`		the returned `PoolList`
Errors	NULL_ARGUMENT		`poolQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`poolQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.