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

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

Tests if this user can perform lookups of queue processor/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.
MethoduseComparativeQueueProcessorDistributorView
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.
MethodusePlenaryQueueProcessorDistributorView
Description

A complete view of the QueueProcessor 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.
MethodgetQueueProcessorIdsByDistributor
Description

Gets the list of QueueProcessorIds associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.id.IdListlist of related queue processor 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.
MethodgetQueueProcessorsByDistributor
Description

Gets the list of queue processors associated with a Distributor.

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

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

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

Gets the list of queue processor corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.provisioning.rules.QueueProcessorListlist of queue processors
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorIdsByQueueProcessor
Description

Gets the Distributor Ids mapped to a QueueProcessor.

Parametersosid.id.IdqueueProcessorId Id of a QueueProcessor
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND queueProcessorId is not found
NULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByQueueProcessor
Description

Gets the Distributors mapped to a QueueProcessor.

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