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

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

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

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

Gets a pool processor enabler query.

Returnosid.provisioning.rules.PoolProcessorEnablerQuerythe pool processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerSearchOrder
Description

Gets a pool processor enabler search order.

Returnosid.provisioning.rules.PoolProcessorEnablerSearchOrderthe pool processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyPoolProcessorEnablerQuery
Description

Applies a pool processor enabler query to this distributor.

Parametersosid.provisioning.rules.PoolProcessorEnablerQuerypoolProcessorEnablerQuerythe pool processor enabler query
ErrorsNULL_ARGUMENT poolProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED poolProcessorEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPoolProcessorEnablerQuery
Description

Gets a pool processor enabler query inspector for this distributor.

Returnosid.provisioning.rules.PoolProcessorEnablerQueryInspectorthe pool processor enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPoolProcessorEnablerSequencing
Description

Applies a pool processor enabler search order to this distributor.

Parametersosid.provisioning.rules.PoolProcessorEnablerSearchOrderpoolProcessorEnablerSearchOrderthe pool processor enabler search order
ErrorsNULL_ARGUMENT poolProcessorEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED poolProcessorEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerQueryFromInspector
Description

Gets a pool processor enabler query from an inspector.

Parametersosid.provisioning.rules.PoolProcessorEnablerQueryInspectorpoolProcessorEnablerQueryInspectora pool processor enabler query inspector
Returnosid.provisioning.rules.PoolProcessorEnablerQuerythe pool processor enabler query
ErrorsNULL_ARGUMENT poolProcessorEnablerQueryInspector is null
UNSUPPORTED poolProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.