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

Interface	osid.provisioning.rules.QueueConstrainerSmartDistributorSession
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 `QueueConstrainerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `QueueConstrainers`. The queue constrainers may be sequenced using the `QueueConstrainerSearchOrder` from this session. This `Distributor` has a default query that matches any queue constrainer and a default search order that specifies no sequencing. The queries may be examined using a `QueueConstrainerQueryInspector`. The query may be modified by converting the inspector back to a `QueueConstrainerQuery`.
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	getQueueConstrainerQuery
Description	Gets a queue constrainer query.
Return	`osid.provisioning.rules.QueueConstrainerQuery`		the queue constrainer query
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerSearchOrder
Description	Gets a queue constrainer search order.
Return	`osid.provisioning.rules.QueueConstrainerSearchOrder`		the queue constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueConstrainerQuery
Description	Applies a queue constrainer query to this distributor.
Parameters	`osid.provisioning.rules.QueueConstrainerQuery`	`queueConstrainerQuery`	the queue constrainer query
Errors	NULL_ARGUMENT		`queueConstrainerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueConstrainerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectQueueConstrainerQuery
Description	Gets a queue constrainer query inspector for this distributor.
Return	`osid.provisioning.rules.QueueConstrainerQueryInspector`		the queue constrainer query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueConstrainerSequencing
Description	Applies a queue constrainer search order to this distributor.
Parameters	`osid.provisioning.rules.QueueConstrainerSearchOrder`	`queueConstrainerSearchOrder`	the queue constrainer search order
Errors	NULL_ARGUMENT		`queueConstrainerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueConstrainerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerQueryFromInspector
Description	Gets a queue constrainer query from an inspector.
Parameters	`osid.provisioning.rules.QueueConstrainerQueryInspector`	`queueConstrainerQueryInspector`	a queue constrainer query inspector
Return	`osid.provisioning.rules.QueueConstrainerQuery`		the queue constrainer query
Errors	NULL_ARGUMENT		`queueConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.