OSID - osid.provisioning.QueueDistributorSession Service Interface Definition

Interface	osid.provisioning.QueueDistributorSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `Queue` to `Distributor` mappings. A `Queue` may appear in multiple `Distributor` objects. Each distributor may have its own authorizations governing who is allowed to look at it. 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
Method	canLookupQueueDistributorMappings
Description	Tests if this user can perform lookups of queue/distributor 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	useComparativeQueueDistributorView
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	usePlenaryQueueDistributorView
Description	A complete view of the `Queue` and `Distributor` 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	getQueueIdsByDistributor
Description	Gets the list of `Queue Ids` associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.id.IdList`		list of related queue `Ids`
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueuesByDistributor
Description	Gets the list of queues associated with a `Distributor.`
Parameters	`osid.id.Id`	`distributorId`	`Id` of the `Distributor`
Return	`osid.provisioning.QueueList`		list of related queues
Errors	NOT_FOUND		`distributorId` is not found
	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueueIdsByDistributors
Description	Gets the list of `Queue Ids` corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.id.IdList`		list of queue `Ids`
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getQueuesByDistributors
Description	Gets the list of queues corresponding to a list of `Distributors.`
Parameters	`osid.id.IdList`	`distributorIds`	list of distributor `Ids`
Return	`osid.provisioning.QueueList`		list of queues
Errors	NULL_ARGUMENT		`distributorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorIdsByQueue
Description	Gets the `Distributor` `Ids` mapped to a `Queue.`
Parameters	`osid.id.Id`	`queueId`	`Id` of a `Queue`
Return	`osid.id.IdList`		list of distributors
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	getDistributorsByQueue
Description	Gets the `Distributors` mapped to a `Queue.`
Parameters	`osid.id.Id`	`queueId`	`Id` of a `Queue`
Return	`osid.provisioning.DistributorList`		list of distributors
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.