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

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

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

A complete view of the QueueProcessorEnabler 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.
MethodgetQueueProcessorEnablerIdsByDistributor
Description

Gets the list of QueueProcessorEnablerIds associated with a Distributor.

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

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

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.provisioning.rules.QueueProcessorEnablerListlist of related queue processor 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.
MethodgetQueueProcessorEnablerIdsByDistributors
Description

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

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

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

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

Gets the Distributor Ids mapped to a QueueProcessorEnabler.

Parametersosid.id.IdqueueProcessorEnablerId Id of a QueueProcessorEnabler
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND queueProcessorEnablerId is not found
NULL_ARGUMENT queueProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByQueueProcessorEnabler
Description

Gets the Distributors mapped to a QueueProcessorEnabler.

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