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

This session provides methods to apply PoolProcessors to Pools.

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

Tests if this user can alter pool processor/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.
MethodassignPoolProcessorToPool
Description

Adds a existing PoolProcessor to a Pool.

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

Removes a PoolProcessor from a Pool.

Parametersosid.id.IdpoolProcessorIdthe Id of the PoolProcessor
osid.id.IdpoolIdthe Id of the Pool
ErrorsNOT_FOUND poolProcessorId or poolId not found or poolProcessorId not applied to poolId
NULL_ARGUMENT poolProcessorId or poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequencePoolProcessors
Description

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

Reorders pool processors for a pool by moving the specified pool processor in front of a reference pool processor.

Parametersosid.id.IdpoolProcessorIdthe Id of a PoolProcessor
osid.id.IdpoolIdthe Id of a Pool
osid.id.IdreferenceIdthe reference pool processor Id
ErrorsNOT_FOUND poolProcessorId, poolId, or referenceId not found or, poolProcessorId or referenceId not related to poolId
NULL_ARGUMENT poolProcessorId, poolId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmovePoolProcessorBehind
Description

Reorders pool processors for a pool by moving the specified pool processor behind a reference pool processor.

Parametersosid.id.IdpoolProcessorIdthe Id of a PoolProcessor
osid.id.IdpoolIdthe Id of a Pool
osid.id.IdreferenceIdthe reference pool processor Id
ErrorsNOT_FOUND poolProcessorId, poolId, or referenceId not found or, poolProcessorId or referenceId not related to poolId
NULL_ARGUMENT poolProcessorId, poolId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderPoolProcessors
Description

Reorders a set of pool processors for a pool.

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