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

Interface	osid.provisioning.rules.PoolEnablerSmartDistributorSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PoolEnablerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `PoolEnablers` . The pool enablers may be sequenced using the `PoolEnablerSearchOrder` from this session. This `Distributor` has a default query that matches any pool enabler and a default search order that specifies no sequencing. The queries may be examined using a `PoolEnablerQueryInspector` . The query may be modified by converting the inspector back to a `PoolEnablerQuery` .
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	getPoolEnablerQuery
Description	Gets a pool enabler query.
Return	`osid.provisioning.rules.PoolEnablerQuery`		the pool enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getPoolEnablerSearchOrder
Description	Gets a pool enabler search order.
Return	`osid.provisioning.rules.PoolEnablerSearchOrder`		the pool enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolEnablerQuery
Description	Applies a pool enabler query to this distributor.
Parameters	`osid.provisioning.rules.PoolEnablerQuery`	`poolEnablerQuery`	the pool enabler query
Errors	NULL_ARGUMENT		`poolEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPoolEnablerQuery
Description	Gets a pool enabler query inspector for this distributor.
Return	`osid.provisioning.rules.PoolEnablerQueryInspector`		the pool enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolEnablerSequencing
Description	Applies a pool enabler search order to this distributor.
Parameters	`osid.provisioning.rules.PoolEnablerSearchOrder`	`poolEnablerSearchOrder`	the pool enabler search order
Errors	NULL_ARGUMENT		`poolEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolEnablerQueryFromInspector
Description	Gets a pool enabler query from an inspector.
Parameters	`osid.provisioning.rules.PoolEnablerQueryInspector`	`poolEnablerQueryInspector`	a pool enabler query inspector
Return	`osid.provisioning.PoolQuery`		the pool enabler query
Errors	NULL_ARGUMENT		`poolEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.