OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.QueueDistributorAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Queue to Distributor mappings. A Queue may appear in multiple Distributor objects and removing the last reference to a Queue is the equivalent of deleting it. Each Distributor may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Queue to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignQueues
Description

Tests if this user can alter queue/distributor 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignQueuesToDistributor
Description

Tests if this user can alter queue/distributor 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 assignment operations to unauthorized users.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIds
Description

Gets a list of distributors including and under the given distributor node in which any queue can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIdsForQueue
Description

Gets a list of distributors including and under the given distributor node in which a specific queue can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdqueueIdthe Id of the Queue
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or queueId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQueueToDistributor
Description

Adds an existing Queue to a Distributor.

Parametersosid.id.IdqueueIdthe Id of the Queue
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTS queueId is already assigned to distributorId
NOT_FOUND queueId or distributorId not found
NULL_ARGUMENT queueId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQueueFromDistributor
Description

Removes a Queue from a Distributor.

Parametersosid.id.IdqueueIdthe Id of the Queue
osid.id.IddistributorIdthe Id of the Distributor
ErrorsNOT_FOUND queueId or distributorId not found or queueId not assigned to distributorId
NULL_ARGUMENT queueId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.