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

Interface	osid.provisioning.rules.QueueProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `QueueProcessors` to `Queues`. Multiple `QueueProcessors` applied to an `Queue` may be sequenced such that the first positive evaluation results in the `QueueProcessor` used.
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	canAssignQueueProcessors
Description	Tests if this user can alter queue processor/queue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignQueueProcessorToQueue
Description	Adds an existing `QueueProcessor` to a `Queue`.
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	ALREADY_EXISTS		`queueProcessorId` already applied to `queueId`
	NOT_FOUND		`queueProcessorId` or `queueId` not found
	NULL_ARGUMENT		`queueProcessorId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueProcessorFromQueue
Description	Removes an existing `QueueProcessor` from a `Queue`.
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueProcessorId` or `queueId` not found or `queueProcessorId` already applied to `queueId`
	NULL_ARGUMENT		`queueProcessorId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceQueueProcessors
Description	Tests if this user can order `QueueProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `QueueProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueProcessorAhead
Description	Reorders queue processors for a queue by moving the specified queue processor in front of a reference queue processor.
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue processor `Id`
Errors	NOT_FOUND		`queueProcessorId queueId`, or `referenceId` not found or, `queueProcessorId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueProcessorId, queueId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueProcessorBehind
Description	Reorders queue processors for a queue by moving the specified queue processor behind a reference queue processor.
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue processor `Id`
Errors	NOT_FOUND		`queueProcessorId, queueId`, or `referenceId` not found or, `queueProcessorId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueProcessorId, queueId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderQueueProcessors
Description	Reorders a set of queue processors for a queue.
Parameters	`osid.id.Id[]`	`queueProcessorIds`	the `Ids` for a set of `QueueProcessors`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueId` not found or, a `queueProcessorId` not related to `queueId`
	NULL_ARGUMENT		`queueProcessorIds` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.