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

Interface	osid.provisioning.rules.QueueConstrainerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `QueueConstrainer` to `Queue` mappings. A `Queue` with multiple `QueueConstrainers` means any positive rule evaluation across the constrainers result in an accessible `Queue.` This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated distributor view: All methods in this session operate, retrieve and pertain queue constrainer defined explicitly in the current distributor federated distributor view: All methods in this session operate, retrieve and pertain to all queue constrainer defined in this distributor and any other queue constrainer implicitly available in this distributor through distributor inheritence.
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	canLookupQueueConstrainerRules
Description	Tests if this user can perform lookups of queue constrainer/queue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeQueueConstrainerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryQueueConstrainerRuleView
Description	A complete view of the `QueueConstrainer` and `Queue` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include queue constrainer in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	getQueueConstrainerIdsForQueue
Description	Gets the `QueueConstrainer Id` associated with a `Queue.`
Parameters	`osid.id.Id`	`queueId`	`Id` of the `Queue`
Return	`osid.id.IdList`		the queue constrainer `Ids`
Errors	NOT_FOUND		`queueId` is not found
	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainersForQueue
Description	Gets the `QueueConstrainer` associated with a `Queue.`
Parameters	`osid.id.Id`	`queueId`	`Id` of the `Queue`
Return	`osid.provisioning.rules.QueueConstrainerList`		the queue constrainers
Errors	NOT_FOUND		`queueId` is not found
	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueueIdsForQueueConstrainer
Description	Gets the `Queue` `Ids` mapped to a `QueueConstrainer.`
Parameters	`osid.id.Id`	`queueConstrainerId`	`Id` of a `QueueConstrainer`
Return	`osid.id.IdList`		list of queue `Ids`
Errors	NOT_FOUND		`queueConstrainerId` is not found
	NULL_ARGUMENT		`queueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueuesForQueueConstrainer
Description	Gets the `Queues` mapped to a `QueueConstrainer.`
Parameters	`osid.id.Id`	`queueConstrainerId`	`Id` of a `QueueConstrainer`
Return	`osid.provisioning.QueueList`		list of queues
Errors	NOT_FOUND		`queueConstrainerId` is not found
	NULL_ARGUMENT		`queueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.