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

This session provides methods to retrieve QueueConstrainerEnabler to QueueConstrainer mappings. a Queue with multiple QueueConstrainerEnablers means any positive rule evaluation across the enablers result in an effective QueueConstrainer.

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
  • isolated distributor view: All methods in this session operate, retrieve and pertain queue constrainer enablers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all queue constrainer enablers defined in this distributor and any other queue constrainer enablers implicitly available in this distributor through distributor inheritence.
MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupQueueConstrainerEnablerRules
Description

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

A complete view of the QueueConstrainerEnabler and QueueConstrainer 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.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include queue constrainer enablers in distributors which are children of this distributor in the distributor hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDistributorView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerEnablerIdsForQueueConstrainer
Description

Gets the QueueConstrainerEnabler Id associated with a QueueConstrainer.

Parametersosid.id.Id queueConstrainerId Id of the QueueConstrainer
Returnosid.id.IdListthe queue constrainer enabler Ids
ErrorsNOT_FOUND queueConstrainerId is not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersForQueueConstrainer
Description

Gets the QueueConstrainerEnablers associated with a QueueConstrainer.

Parametersosid.id.IdqueueConstrainerId Id of the QueueConstrainer
Returnosid.provisioning.rules.QueueConstrainerEnablerListthe queue constrainer enablers
ErrorsNOT_FOUND queueConstrainerId is not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerIdsForQueueConstrainerEnabler
Description

Gets the QueueConstrainer Ids mapped to a QueueConstrainerEnabler.

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

Gets the QueueConstrainers mapped to a QueueConstrainerEnabler.

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