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

Interface	osid.provisioning.rules.QueueProcessorEnablerSmartDistributorSession
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 `QueueProcessorEnablerQuery` can be retrieved from this session and mapped to this `Distributor` to create a virtual collection of `QueueProcessorEnablers` . The queue processor enablers may be sequenced using the `QueueProcessorEnablerSearchOrder` from this session. This `Distributor` has a default query that matches any queue processor enabler and a default search order that specifies no sequencing. The queries may be examined using a `QueueProcessorEnablerQueryInspector` . The query may be modified by converting the inspector back to a `QueueProcessorEnablerQuery` .
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	getQueueProcessorEnablerQuery
Description	Gets a queue processor enabler query.
Return	`osid.provisioning.rules.QueueProcessorEnablerQuery`		the queue processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorEnablerSearchOrder
Description	Gets a queue processor enabler search order.
Return	`osid.provisioning.rules.QueueProcessorEnablerSearchOrder`		the queue processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueProcessorEnablerQuery
Description	Applies a queue processor enabler query to this distributor.
Parameters	`osid.provisioning.rules.QueueProcessorEnablerQuery`	`queueProcessorEnablerQuery`	the queue processot enabler query
Errors	NULL_ARGUMENT		`queueProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectQueueProcessorEnablerQuery
Description	Gets a queue processor enabler query inspector for this distributor.
Return	`osid.provisioning.rules.QueueProcessorEnablerQueryInspector`		the queue processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyQueueProcessorEnablerSequencing
Description	Applies a queue processor enabler search order to this distributor.
Parameters	`osid.provisioning.rules.QueueProcessorEnablerSearchOrder`	`queueProcessorEnablerSearchOrder`	the queue processor enabler search order
Errors	NULL_ARGUMENT		`queueProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`queueProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorEnablerQueryFromInspector
Description	Gets a queue processor enabler query from an inspector.
Parameters	`osid.provisioning.rules.QueueProcessorEnablerQueryInspector`	`queueProcessorEnablerQueryInspector`	a queue processor enabler query inspector
Return	`osid.provisioning.rules.QueueProcessorEnablerQuery`		the queue processor enabler query
Errors	NULL_ARGUMENT		`queueProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`queueProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.