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

This session manages queries and sequencing to create "smart" dynamic distributors. a QueueConstrainerEnablerQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of queue constrainer enablers. The queue constrainer enablers may be sequenced using the QueueConstrainerEnablerSearchOrder from this session.

This Distributor has a default query that matches any queue constrainer enabler and a default search order that specifies no sequencing. The queries may be examined using a QueueConstrainerEnablerQueryInspector. The query may be modified by converting the inspector back to a QueueConstrainerEnablerQuery.

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.
MethodcanManageSmartDistributors
Description

Tests if this user can manage smart distributors. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart distributor management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerQuery
Description

Gets a queue constrainer enabler query.

Returnosid.provisioning.rules.QueueConstrainerEnablerQuerythe queue constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerSearchOrder
Description

Gets a queue constrainer enabler search order.

Returnosid.provisioning.rules.QueueConstrainerEnablerSearchOrderthe queue constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyQueueConstrainerEnablerQuery
Description

Applies a queue constrainer enabler query to this distributor.

Parametersosid.provisioning.rules.QueueConstrainerEnablerQueryqueueConstrainerEnablerQuerythe queue constrainer enabler query
ErrorsNULL_ARGUMENT queueConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueConstrainerEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectQueueConstrainerEnablerQuery
Description

Gets a queue constrainer enabler query inspector for this distributor.

Returnosid.provisioning.rules.QueueConstrainerEnablerQueryInspectorthe queue constrainer enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyQueueConstrainerEnablerSequencing
Description

Applies a queue constrainer enabler search order to this distributor.

Parametersosid.provisioning.rules.QueueConstrainerEnablerSearchOrderqueueConstrainerEnablerSearchOrderthe queue constrainer enabler search order
ErrorsNULL_ARGUMENT queueConstrainerEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueConstrainerEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerQueryFromInspector
Description

Gets a queue constrainer enabler query from an inspector.

Parametersosid.provisioning.rules.QueueConstrainerEnablerQueryInspectorqueueConstrainerEnablerQueryInspectora queue constrainer enabler query inspector
Returnosid.provisioning.rules.QueueConstrainerEnablerQuerythe queue constrainer enabler query
ErrorsNULL_ARGUMENT queueConstrainerEnablerQueryInspector is null
UNSUPPORTED queueConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.