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

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

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

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

Gets a pool constrainer query.

Returnosid.provisioning.rules.PoolConstrainerQuerythe pool constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerSearchOrder
Description

Gets a pool constrainer search order.

Returnosid.provisioning.rules.PoolConstrainerSearchOrderthe pool constrainer search order
CompliancemandatoryThis method must be implemented.
MethodapplyPoolConstrainerQuery
Description

Applies a pool constrainer query to this distributor.

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

Gets a pool constrainer query inspector for this distributor.

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

Applies a pool constrainer search order to this distributor.

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

Gets a pool constrainer query from an inspector.

Parametersosid.provisioning.rules.PoolConstrainerQueryInspectorpoolConstrainerQueryInspectora pool constrainer query inspector
Returnosid.provisioning.rules.PoolConstrainerQuerythe pool constrainer query
ErrorsNULL_ARGUMENT poolConstrainerQueryInspector is null
UNSUPPORTED poolConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.