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

Interface	osid.provisioning.rules.QueueProcessorSmartDistributorSession
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 `QueueProcessorQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `QueueProcessors`. The queue processors may be sequenced using the `QueueProcessorSearchOrder` from this session. This `Distributor` has a default query that matches any queue processor and a default search order that specifies no sequencing. The queries may be examined using a `QueueProcessorQueryInspector`. The query may be modified by converting the inspector back to a `QueueProcessorQuery`.
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	getQueueProcessorQuery
Description	Gets a queue processor query.
Return	`osid.provisioning.rules.QueueProcessorQuery`		the queue processor query
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorSearchOrder
Description	Gets a queue processor search order.
Return	`osid.provisioning.rules.QueueProcessorSearchOrder`		the queue processor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueProcessorQuery
Description	Applies a queue processor query to this distributor.
Parameters	`osid.provisioning.rules.QueueProcessorQuery`	`queueProcessorQuery`	the queue processor query
Errors	NULL_ARGUMENT		`queueProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueProcessorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectQueueProcessorQuery
Description	Gets a queue processor query inspector for this distributor.
Return	`osid.provisioning.rules.QueueProcessorQueryInspector`		the queue processor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueProcessorSequencing
Description	Applies a queue processor search order to this distributor.
Parameters	`osid.provisioning.rules.QueueProcessorSearchOrder`	`queueProcessorSearchOrder`	the queue processor search order
Errors	NULL_ARGUMENT		`queueProcessorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueProcessorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorQueryFromInspector
Description	Gets a queue processor query from an inspector.
Parameters	`osid.provisioning.rules.QueueProcessorQueryInspector`	`queueProcessorQueryInspector`	a queue processor query inspector
Return	`osid.provisioning.rules.QueueProcessorQuery`		the queue processor query
Errors	NULL_ARGUMENT		`queueProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`queueProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.