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

Interface	osid.provisioning.rules.PoolConstrainerSmartDistributorSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic distributors. A `PoolConstrainerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of pool constrainers. The pool constrainer may be sequenced using the `PoolConstrainerSearchOrder` from this session. This `Distributor` has a default query that matches any pool constrainer and a default search order that specifies no sequencing. The queries may be examined using a `PoolConstrainerQueryInspector.` The query may be modified by converting the inspector back to a `PoolConstrainerQuery.`
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	getPoolConstrainerQuery
Description	Gets a pool constrainer query.
Return	`osid.provisioning.rules.PoolConstrainerQuery`		the pool constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerSearchOrder
Description	Gets a pool constrainer search order.
Return	`osid.provisioning.rules.PoolConstrainerSearchOrder`		the pool constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolConstrainerQuery
Description	Applies a pool constrainer query to this distributor.
Parameters	`osid.provisioning.rules.PoolConstrainerQuery`	`poolConstrainerQuery`	the pool constrainer query
Errors	NULL_ARGUMENT		`poolConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPoolConstrainerQuery
Description	Gets a pool constrainer query inspector for this distributor.
Return	`osid.provisioning.rules.PoolConstrainerQueryInspector`		the pool constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPoolConstrainerSequencing
Description	Applies a pool constrainer search order to this distributor.
Parameters	`osid.provisioning.rules.PoolConstrainerSearchOrder`	`poolConstrainerSearchOrder`	the pool constrainer search order
Errors	NULL_ARGUMENT		`poolConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`poolConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPoolConstrainerQueryFromInspector
Description	Gets a pool constrainer query from an inspector.
Parameters	`osid.provisioning.rules.PoolConstrainerQueryInspector`	`poolConstrainerQueryInspector`	a pool constrainer query inspector
Return	`osid.provisioning.rules.PoolConstrainerQuery`		the pool constrainer query
Errors	NULL_ARGUMENT		`poolConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`poolConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.