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

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

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

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

Gets a pool processor query.

Returnosid.provisioning.rules.PoolProcessorQuerythe pool processor query
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorSearchOrder
Description

Gets a pool processor search order.

Returnosid.provisioning.rules.PoolProcessorSearchOrderthe pool processor search order
CompliancemandatoryThis method must be implemented.
MethodapplyPoolProcessorQuery
Description

Applies a pool processor query to this distributor.

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

Gets a pool processor query inspector for this distributor.

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

Applies a pool processor search order to this distributor.

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

Gets a pool processor query from an inspector.

Parametersosid.provisioning.rules.PoolProcessorQueryInspectorpoolProcessorQueryInspectora pool processor query inspector
Returnosid.provisioning.rules.PoolProcessorQuerythe pool processor query
ErrorsNULL_ARGUMENT poolProcessorQueryInspector is null
UNSUPPORTED poolProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.