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

Interface	osid.provisioning.rules.QueueConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.rules.ProvisioningRulesManager`
Used By	`osid.provisioning.rules.ProvisioningRulesProxyManager`
Description	This session provides methods to apply `QueueConstrainerEnablers` to `QueueConstrainers` . Multiple `QueueConstrainerEnablers` applied to an `QueueConstrainer` may be sequenced such that the first positive evaluation results in the `QueueConstrainerEnabler` 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	canAssignQueueConstrainerEnablers
Description	Tests if this user can alter queue constrainer enabler/queue constrainer 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	assignQueueConstrainerEnablerToQueueConstrainer
Description	Adds an existing `QueueConstrainerEnabler` to a `QueueConstrainer` .
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler`
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
Errors	ALREADY_EXISTS		`queueConstrainerEnablerId` already applied to `queueConstrainerId`
	NOT_FOUND		`queueConstrainerEnablerId` or `queueConstrainerId` not found
	NULL_ARGUMENT		`queueConstrainerEnablerId` or `queueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignQueueConstrainerEnablerFromQueueConstrainer
Description	Removes an existing `QueueConstrainerEnabler` from a `QueueConstrainer` .
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler`
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
Errors	NOT_FOUND		`queueConstrainerEnablerId` or `queueConstrainerId` not found or `queueConstrainerEnablerId` already applied to `queueConstrainerId`
	NULL_ARGUMENT		`queueConstrainerEnablerId` or `queueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceQueueConstrainerEnablers
Description	Tests if this user can order `QueueConstrainerEnablers` . 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 `QueueConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueConstrainerEnablerAhead
Description	Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler in front of a reference queue constrainer enabler.
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler`
	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
	`osid.id.Id`	`referenceId`	the reference queue constrainer enabler `Id`
Errors	NOT_FOUND		`queueConstrainerEnablerId queueConstrainerId` , or `referenceId` not found or, `queueConstrainerEnablerId` or `referenceId` not related to `queueConstrainerId`
	NULL_ARGUMENT		`queueConstrainerEnablerId, queueConstrainerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveQueueConstrainerEnablerBehind
Description	Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler behind a reference queue constrainer enabler.
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler`
	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
	`osid.id.Id`	`referenceId`	the reference queue constrainer `Id`
Errors	NOT_FOUND		`queueConstrainerEnablerId queueConstrainerId` , or `referenceId` not found or, `queueConstrainerEnablerId` or `referenceId` not related to `queueConstrainerId`
	NULL_ARGUMENT		`queueConstrainerEnablerId, queueConstrainerId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderQueueConstrainerEnablers
Description	Reorders a set of queue constrainer enablers for a queue constrainer.
Parameters	`osid.id.Id[]`	`queueConstrainerEnablerIds`	the `Ids` for a set of `QueueConstrainerEnablers`
Parameters	`osid.id.Id`	`queueConstrainerId`	the `Id` of the `QueueConstrainer`
Errors	NOT_FOUND		`queueConstrainerId` not found or, a `queueConstrainerEnablerId` not related to `queueConstrainerId`
	NULL_ARGUMENT		`queueConstrainerEnablerIds` or `queueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.