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

This session provides methods to re-assign QueueConstrainer to Distributor mappings. a QueueConstrainer may appear in multiple Distributor objects and removing the last reference to a QueueConstrainer 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 QueueConstrainer to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignQueueConstrainers
Description

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

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

Tests if this user can alter queue constrainer/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 lookup 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 constrainer 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.
MethodgetAssignableDistributorIdsForQueueConstrainer
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or queueConstrainerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQueueConstrainerToDistributor
Description

Adds an existing QueueConstrainer to a Distributor.

Parametersosid.id.IdqueueConstrainerIdthe Id of the QueueConstrainer
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTS queueConstrainerId is not assigned to distributorId
NOT_FOUND queueConstrainerId or distributorId not found
NULL_ARGUMENT queueConstrainerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQueueConstrainerFromDistributor
Description

Removes a QueueConstrainer from a Distributor.

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