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

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

MethodcanAssignQueueProcessorEnablers
Description

Tests if this user can alter queue processor enabler/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.
MethodcanAssignQueueProcessorEnablersToDistributor
Description

Tests if this user can alter queue processor enabler/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 processor enabler 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.
MethodgetAssignableDistributorIdsForQueueProcessorEnabler
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdqueueProcessorEnablerIdthe Id of the QueueProcessorEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or queueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQueueProcessorEnablerToDistributor
Description

Adds an existing QueueProcessorEnabler to a Distributor.

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

Removes a QueueProcessorEnabler from a Distributor.

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