OSID - osid.provisioning.PoolSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.PoolSmartDistributorSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PoolQuery` can be retrieved from this session and distributorped to this `Distributor` to create a virtual collection of `Pools.` The pools may be sequenced using the `PoolSearchOrder` from this session. This `Distributor` has a default query that matches any pool and a default search order that specifies no sequencing. The queries may be examined using a `PoolQueryInspector.` The query may be modified by converting the inspector back to a `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	canManageSmartDistributors
Description	Tests if this user can manage smart distributors. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart distributor management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getPoolSearchOrder
Description	Gets a pool search order.
Return	`osid.provisioning.PoolSearchOrder`		the pool search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolQuery
Description	Applies a pool query to this distributor.
Parameters	`osid.provisioning.PoolQuery`	`poolQuery`	the pool query
Errors	NULL_ARGUMENT		`poolQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPoolQuery
Description	Gets a pool query inspector for this distributor.
Return	`osid.provisioning.PoolQueryInspector`		the pool query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolSequencing
Description	Applies a pool search order to this distributor.
Parameters	`osid.provisioning.PoolSearchOrder`	`poolSearchOrder`	the pool search order
Errors	NULL_ARGUMENT		`poolSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolQueryFromInspector
Description	Gets a pool query from an inspector.
Parameters	`osid.provisioning.PoolQueryInspector`	`poolQueryInspector`	a pool query inspector
Return	`osid.provisioning.PoolQuery`		the pool query
Errors	NULL_ARGUMENT		`poolQueryInspector` is `null`
Errors	UNSUPPORTED		`poolQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.