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

This session provides methods to apply PoolConstrainers to Pools. A Pool with multiple PoolConstrainers means any positive rule evaluation across the constrainers result in an accessible Pool.

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

Tests if this user can alter pool constrainer/pool mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignPoolConstrainerToPool
Description

Adds an existing PoolConstrainer to a Pool.

Parametersosid.id.IdpoolConstrainerIdthe Id of the PoolConstrainer
osid.id.IdpoolIdthe Id of the Pool
ErrorsALREADY_EXISTS poolConstrainerId is already applied to poolId
NOT_FOUND poolConstrainerId or poolId not found
NULL_ARGUMENT poolConstrainerId or poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPoolConstrainerFromPool
Description

Removes a PoolConstrainer from a Pool.

Parametersosid.id.IdpoolConstrainerIdthe Id of the PoolConstrainer
osid.id.IdpoolIdthe Id of the Pool
ErrorsNOT_FOUND poolConstrainerId or poolId not found or poolConstrainerId not applied to poolId
NULL_ARGUMENT poolConstrainerId or poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequencePoolConstrainers
Description

Tests if this user can order PoolConstrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if PoolConstrainer ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmovePoolConstrainerAhead
Description

Reorders pool constrainers for a pool by moving the specified pool constrainer in front of a reference pool constrainer.

Parametersosid.id.IdpoolConstrainerIdthe Id of a PoolConstrainer
osid.id.IdpoolIdthe Id of a Pool
osid.id.IdreferenceIdthe reference pool constrainer Id
ErrorsNOT_FOUND poolConstrainerId, poolId, or referenceId not found or, poolConstrainerId or referenceId not related to poolId
NULL_ARGUMENT poolConstrainerId, poolId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmovePoolConstrainerBehind
Description

Reorders pool constrainers for a pool by moving the specified pool constrainer behind a reference pool constrainer.

Parametersosid.id.IdpoolConstrainerIdthe Id of a PoolConstrainer
osid.id.IdpoolIdthe Id of a Pool
osid.id.IdreferenceIdthe reference pool constrainer Id
ErrorsNOT_FOUND poolConstrainerId, poolId, or referenceId not found or, poolConstrainerId or referenceId not related to poolId
NULL_ARGUMENT poolConstrainerId, poolId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderPoolConstrainers
Description

Reorders a set of pool constrainers for a pool.

Parametersosid.id.Id[]poolConstrainerIdsthe Ids for a set of PoolConstrainers
osid.id.IdpoolIdthe Id of a Pool
ErrorsNOT_FOUND poolId not found or, a poolConstrainerId not related to poolId
NULL_ARGUMENT poolConstrainerIds or poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.