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

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

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

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

Gets a queue processor enabler query.

Returnosid.provisioning.rules.QueueProcessorEnablerQuerythe queue processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerSearchOrder
Description

Gets a queue processor enabler search order.

Returnosid.provisioning.rules.QueueProcessorEnablerSearchOrderthe queue processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyQueueProcessorEnablerQuery
Description

Applies a queue processor enabler query to this distributor.

Parametersosid.provisioning.rules.QueueProcessorEnablerQueryqueueProcessorEnablerQuerythe queue processor enabler query
ErrorsNULL_ARGUMENT queueProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueProcessorEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectQueueProcessorEnablerQuery
Description

Gets a queue processor enabler query inspector for this distributor.

Returnosid.provisioning.rules.QueueProcessorEnablerQueryInspectorthe queue processor enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyQueueProcessorEnablerSequencing
Description

Applies a queue processor enabler search order to this distributor.

Parametersosid.provisioning.rules.QueueProcessorEnablerSearchOrderqueueProcessorEnablerSearchOrderthe queue processor enabler search order
ErrorsNULL_ARGUMENT queueProcessorEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueProcessorEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerQueryFromInspector
Description

Gets a queue processor enabler query from an inspector.

Parametersosid.provisioning.rules.QueueProcessorEnablerQueryInspectorqueueProcessorEnablerQueryInspectora queue processor enabler query inspector
Returnosid.provisioning.rules.QueueProcessorEnablerQuerythe queue processor enabler query
ErrorsNULL_ARGUMENT queueProcessorEnablerQueryInspector is null
UNSUPPORTED queueProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.