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

Interface	osid.provisioning.rules.QueueEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `QueueEnablers` to `Queues`. Multiple `QueueEnablers` applied to an `Queue` may be sequenced such that the first positive evaluation results in the `QueueEnablers` 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	canAssignQueueEnablers
Description	Tests if this user can alter queue enabler/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	assignQueueEnablerToQueue
Description	Adds an existing `QueueEnabler` to a `Queue`.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	ALREADY_EXISTS		`queueEnablerId` already applied to `queueId`
	NOT_FOUND		`queueEnablerId` or `queueId` not found
	NULL_ARGUMENT		`queueEnablerId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueEnablerFromQueue
Description	Removes an existing `QueueEnabler` from a `Queue`.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueEnablerId` or `queueId` not found or `queueEnablerId` already applied to `queueId`
	NULL_ARGUMENT		`queueEnablerId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceQueueEnablers
Description	Tests if this user can order `QueueEnablers`. 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 `QueueEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueEnablerAhead
Description	Reorders queue enablers for a queue by moving the specified queue enabler in front of a reference queue enabler.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue enabler `Id`
Errors	NOT_FOUND		`queueEnablerId, queueId`, or `referenceId` not found or, `queueEnablerId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueEnablerId, queueId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueEnablerBehind
Description	Reorders queue enablers for a queue by moving the specified queue enabler behind a reference queue enabler.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue enabler `Id`
Errors	NOT_FOUND		`queueEnablerId, queueId`, or `referenceId` not found or, `queueEnablerId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueEnablerId, queueId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderQueueEnablers
Description	Reorders a set of queue enablers for a queue.
Parameters	`osid.id.Id[]`	`queueEnablerIds`	the `Ids` for a set of `QueueEnablers`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueEnablerId, queueId`, or `referenceId` not found or, `queueEnablerId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueEnablerIds, queueId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.