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

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

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

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

Gets a pool constrainer enabler query.

Returnosid.provisioning.rules.PoolConstrainerEnablerQuerythe pool constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerSearchOrder
Description

Gets a pool constrainer enabler search order.

Returnosid.provisioning.rules.PoolConstrainerEnablerSearchOrderthe pool constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyPoolConstrainerEnablerQuery
Description

Applies a pool constrainer enabler query to this distributor.

Parametersosid.provisioning.rules.PoolConstrainerEnablerQuerypoolConstrainerEnablerQuerythe pool constrainer enabler query
ErrorsNULL_ARGUMENT poolConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED poolConstrainerEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPoolConstrainerEnablerQuery
Description

Gets a pool constrainer enabler query inspector for this distributor.

Returnosid.provisioning.rules.PoolConstrainerEnablerQueryInspectorthe pool constrainer enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPoolConstrainerEnablerSequencing
Description

Applies a pool constrainer enabler search order to this distributor.

Parametersosid.provisioning.rules.PoolConstrainerEnablerSearchOrderpoolConstrainerEnablerSearchOrderthe pool constrainer enabler search order
ErrorsNULL_ARGUMENT poolConstrainerEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED poolConstrainerEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerQueryFromInspector
Description

Gets a pool constrainer enabler query from an inspector.

Parametersosid.provisioning.rules.PoolConstrainerEnablerQueryInspectorpoolConstrainerEnablerQueryInspectora pool constrainer enabler query inspector
Returnosid.provisioning.rules.PoolConstrainerEnablerQuerythe pool constrainer enabler query
ErrorsNULL_ARGUMENT poolConstrainerEnablerQueryInspector is null
UNSUPPORTED poolConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.