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

This session provides methods to retrieve QueueConstrainerEnabler to Distributor mappings. a QueueConstrainerEnabler 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
MethodcanLookupQueueConstrainerEnablerDistributorMappings
Description

Tests if this user can perform lookups of queue constrainer enabler/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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeQueueConstrainerEnablerDistributorView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryQueueConstrainerEnablerDistributorView
Description

A complete view of the QueueConstrainerEnabler 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.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerEnablerIdsByDistributor
Description

Gets the list of QueueConstrainerEnablerIds associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.id.IdListlist of related queue constrainer enabler Ids
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByDistributor
Description

Gets the list of queue constrainer enablers associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.provisioning.rules.QueueConstrainerEnablerListlist of related queue constrainer enablers
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerIdsByDistributors
Description

Gets the list of QueueConstrainerEnabler Ids corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.id.IdListlist of queue constrainer enabler Ids
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByDistributors
Description

Gets the list of queue constrainer enablers corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.provisioning.rules.QueueConstrainerEnablerListlist of queue constrainer enablers
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorIdsByQueueConstrainerEnabler
Description

Gets the Distributor Ids mapped to a QueueConstrainerEnabler.

Parametersosid.id.IdqueueConstrainerEnablerId Id of a QueueConstrainerEnabler
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND queueConstrainerEnablerId is not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByQueueConstrainerEnabler
Description

Gets the Distributors mapped to a QueueConstrainerEnabler.

Parametersosid.id.IdqueueConstrainerEnablerId Id of a QueueConstrainerEnabler
Returnosid.provisioning.DistributorListlist of distributors
ErrorsNOT_FOUND queueConstrainerEnablerId is not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.