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

Interface	osid.provisioning.rules.QueueConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `QueueConstrainers` to `Queues` . Multiple `QueueConstrainers` applied to an `Queue` may be sequenced such that the first positive evaluation results in the `QueueConstrainer` 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	canAssignQueueConstrainers
Description	Tests if this user can alter queue constrainer/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	assignQueueConstrainerToQueue
Description	Adds an existing `QueueConstrainer` to a `Queue` .
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	ALREADY_EXISTS		`queueConstrainerId` already applied to `queueId`
	NOT_FOUND		`queueConstrainerId` or `queueId` not found
	NULL_ARGUMENT		`queueConstrainerId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueConstrainerFromQueue
Description	Removes an existing `QueueConstrainer` from a `Queue` .
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueConstrainerId` or `queueId` not found or `queueConstrainerId` already applied to `queueId`
	NULL_ARGUMENT		`queueConstrainerId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceQueueConstrainers
Description	Tests if this user can order `QueueConstrainers` . 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 `QueueConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueConstrainerAhead
Description	Reorders queue constrainers for a queue by moving the specified queue constrainer in front of a reference queue constrainer.
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue constrainer `Id`
Errors	NOT_FOUND		`queueConstrainerId, queueId` , or `referenceId` not found or, `queueConstrainerId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueConstrainerId, queueId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueConstrainerBehind
Description	Reorders queue constrainers for a queue by moving the specified queue constrainer behind a reference queue constrainer.
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
	`osid.id.Id`	`referenceId`	the reference queue constrainer `Id`
Errors	NOT_FOUND		`queueConstrainerId, queueId` , or `referenceId` not found or, `queueConstrainerId` or `referenceId` not related to `queueId`
	NULL_ARGUMENT		`queueConstrainerId, queueId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderQueueConstrainers
Description	Reorders a set of queue constrainers for a queue.
Parameters	`osid.id.Id[]`	`queueConstrainerIds`	the `Ids` for a set of `QueueConstrainers`
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue`
Errors	NOT_FOUND		`queueId` not found or, a `queueConstrainerId` not related to `queueId`
	NULL_ARGUMENT		`queueConstrainerIds` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.