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

This session provides methods to apply PoolConstrainerEnablers to PoolConstrainers. A PoolConstrainer with multiple PoolConstrainerEnablers means any positive rule evaluation across the enablers result in an effective PoolConstrainer.

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

Tests if this user can alter pool constrainer enabler/pool constrainer 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.
MethodassignPoolConstrainerEnablerToPoolConstrainer
Description

Adds an existing PoolConstrainerEnabler to a PoolConstrainer.

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

Removes a PoolConstrainerEnabler from a PoolConstrainer.

Parametersosid.id.IdpoolConstrainerEnablerIdthe Id of the PoolConstrainerEnabler
osid.id.IdpoolConstrainerIdthe Id of the PoolConstrainer
ErrorsNOT_FOUND poolConstrainerEnablerId or poolConstrainerId not found or poolConstrainerEnablerId not applied to poolConstrainerId
NULL_ARGUMENT poolConstrainerEnablerId or poolConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequencePoolConstrainerEnablers
Description

Tests if this user can order PoolConstrainerEnablers. 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 PoolConstrainerEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmovePoolConstrainerEnablerAhead
Description

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

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

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

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

Reorders a set of pool constrainer enablers for a pool constrainer.

Parametersosid.id.Id[]poolConstrainerEnablerIdsthe Ids for a set of PoolConstrainerEnablers
osid.id.IdpoolConstrainerIdthe Id of a PoolConstrainer
ErrorsNOT_FOUND poolConstrainerId not found or, a poolConstrainerEnablerId not related to poolConstrainerId
NULL_ARGUMENT poolConstrainerEnablerIds or poolConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.