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

Interface	osid.provisioning.rules.PoolConstrainerEnablerSmartDistributorSession
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 `PoolConstrainerEnablerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `PoolConstrainerEnablers`. The pool constrainer enablers may be sequenced using the `PoolConstrainerEnablerSearchOrder` from this session. This `Distributor` has a default query that matches any pool constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using a `PoolConstrainerEnablerQueryInspector`. The query may be modified by converting the inspector back to a `PoolConstrainerEnablerQuery`.
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	getPoolConstrainerEnablerQuery
Description	Gets a pool constrainer enabler query.
Return	`osid.provisioning.rules.PoolConstrainerEnablerQuery`		the pool constrainer enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerEnablerSearchOrder
Description	Gets a pool constrainer enabler search order.
Return	`osid.provisioning.rules.PoolEnablerSearchOrder`		the pool constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolConstrainerEnablerQuery
Description	Applies a pool constrainer enabler query to this distributor.
Parameters	`osid.provisioning.rules.PoolConstrainerEnablerQuery`	`poolConstrainerEnablerQuery`	the pool constrainer enabler query
Errors	NULL_ARGUMENT		`poolConstrainerEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolConstrainerEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPoolConstrainerEnablerQuery
Description	Gets a pool constrainer enabler query inspector for this distributor.
Return	`osid.provisioning.rules.PoolConstrainerEnablerQueryInspector`		the pool constrainer enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolConstrainerEnablerSequencing
Description	Applies a pool constrainer enabler search order to this distributor.
Parameters	`osid.provisioning.rules.PoolConstrainerEnablerSearchOrder`	`poolConstrainerEnablerSearchOrder`	the pool constrainer enabler search order
Errors	NULL_ARGUMENT		`poolConstrainerEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolConstrainerEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerEnablerQueryFromInspector
Description	Gets a pool constrainer enabler query from an inspector.
Parameters	`osid.provisioning.rules.PoolConstrainerEnablerQueryInspector`	`poolConstrainerEnablerQueryInspector`	a pool constrainer enabler query inspector
Return	`osid.provisioning.rules.PoolConstrainerEnablerQuery`		the pool constrainer enabler query
Errors	NULL_ARGUMENT		`poolConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.