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

Interface	osid.provisioning.rules.QueueProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `QueueProcessorEnablers` to `QueueProcessors` . Multiple `QueueProcessorEnablers` applied to an `QueueProcessor` may be sequenced such that the first positive evaluation results in the `QueueProcessorEnabler` 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	canAssignQueueProcessorEnablers
Description	Tests if this user can alter queue processor enabler/queue processor 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	assignQueueProcessorEnablerToQueueProcessor
Description	Adds an existing `QueueProcessorEnabler` to a `QueueProcessor` .
Parameters	`osid.id.Id`	`queueProcessorEnablerId`	the `Id` of the `QueueProcessorEnabler`
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Errors	ALREADY_EXISTS		`queueProcessorEnablerId` already applied to `queueProcessorId`
	NOT_FOUND		`queueProcessorEnablerId` or `queueProcessorId` not found
	NULL_ARGUMENT		`queueProcessorEnablerId` or `queueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueProcessorEnablerFromQueueProcessor
Description	Removes an existing `QueueProcessorEnabler` from a `QueueProcessor` .
Parameters	`osid.id.Id`	`queueProcessorEnablerId`	the `Id` of the `QueueProcessorEnabler`
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Errors	NOT_FOUND		`queueProcessorEnablerId` or `queueProcessorId` not found or `queueProcessorEnablerId` already applied to `queueProcessorId`
	NULL_ARGUMENT		`queueProcessorEnablerId` or `queueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceQueueProcessorEnablers
Description	Tests if this user can order `QueueProcessorEnablers` . 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 `QueueProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueProcessorEnablerAhead
Description	Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler in front of a reference queue processor enabler.
Parameters	`osid.id.Id`	`queueProcessorEnablerId`	the `Id` of the `QueueProcessorEnabler`
	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
	`osid.id.Id`	`referenceId`	the reference queue processor enabler `Id`
Errors	NOT_FOUND		`queueProcessorEnablerId queueProcessorId` , or `referenceId` not found or, `queueProcessorEnablerId` or `referenceId` not related to `queueProcessorId`
	NULL_ARGUMENT		`queueProcessorEnablerId, queueProcessorId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueProcessorEnablerBehind
Description	Reorders queue processor enablers for a queue processor by moving the specified queue processor enabler behind a reference queue processor enabler.
Parameters	`osid.id.Id`	`queueProcessorEnablerId`	the `Id` of the `QueueProcessorEnabler`
	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
	`osid.id.Id`	`referenceId`	the reference queue processor `Id`
Errors	NOT_FOUND		`queueProcessorEnablerId queueProcessorId` , or `referenceId` not found or, `queueProcessorEnablerId` or `referenceId` not related to `queueProcessorId`
	NULL_ARGUMENT		`queueProcessorEnablerId, queueProcessorId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderQueueProcessorEnablers
Description	Reorders a set of queue processor enablers for a queue processor.
Parameters	`osid.id.Id[]`	`queueProcessorEnablerIds`	the `Ids` for a set of `QueueProcessorEnablers`
Parameters	`osid.id.Id`	`queueProcessorId`	the `Id` of the `QueueProcessor`
Errors	NOT_FOUND		`queueProcessorId` not found or, a `queueProcessorEnablerId` not related to `queueProcessorId`
	NULL_ARGUMENT		`queueProcessorEnablerIds` or `queueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.