OSID - osid.provisioning.QueueSmartDistributorSession Service Interface Definition

Interface	osid.provisioning.QueueSmartDistributorSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `QueueQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of queues. The queues may be sequenced using the `QueueSearchOrder` from this session. This `Distributor` has a default query that matches any queue and a default search order that specifies no sequencing. The queries may be examined using a `QueueQueryInspector`. The query may be modified by converting the inspector back to a `QueueQuery`.
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	getQueueQuery
Description	Gets a queue query.
Return	`osid.provisioning.QueueQuery`		the queue query
Compliance	`mandatory`		This method must be implemented.
Method	getQueueSearchOrder
Description	Gets a queue search order.
Return	`osid.provisioning.QueueSearchOrder`		the queue search order
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueQuery
Description	Applies a queue query to this distributor.
Parameters	`osid.provisioning.QueueQuery`	`queueQuery`	the queue query
Errors	NULL_ARGUMENT		`queueQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecQueueQuery
Description	Gets a queue query inspector for this distributor.
Return	`osid.provisioning.QueueQueryInspector`		the queue query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueSequencing
Description	Applies a queue search order to this distributor.
Parameters	`osid.provisioning.QueueSearchOrder`	`queueSearchOrder`	the queue search order
Errors	NULL_ARGUMENT		`queueSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueQueryFromInspector
Description	Gets a queue query from an inspector.
Parameters	`osid.provisioning.QueueQueryInspector`	`queueQueryInspector`	a queue query inspector
Return	`osid.provisioning.QueueQuery`		the queue query
Errors	NULL_ARGUMENT		`queueQueryInspector` is `null`
Errors	UNSUPPORTED		`queueQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.