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

This session provides methods to apply PoolProcessorEnablers to PoolProcessors. A PoolProcessor with multiple PoolProcessorEnablers means any positive rule evaluation across the enablers result in an effective PoolProcessor.

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

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

Adds an existing PoolProcessorEnabler to a PoolProcessor.

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

Removes a PoolProcessorEnabler from a PoolProcessor.

Parametersosid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler
osid.id.IdpoolProcessorIdthe Id of the PoolProcessor
ErrorsNOT_FOUND poolProcessorEnablerId or poolProcessorId not found or poolProcessorEnablerId not applied to poolProcessorId
NULL_ARGUMENT poolProcessorEnablerId or poolProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequencePoolProcessorEnablers
Description

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

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

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

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

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

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

Parametersosid.id.Id[]poolProcessorEnablerIdsthe Ids for a set of PoolProcessorEnablers
osid.id.IdpoolProcessorIdthe Id of a PoolProcessor
ErrorsNOT_FOUND poolProcessorId not found or, a poolProcessorEnablerId not related to poolProcessorId
NULL_ARGUMENT poolProcessorEnablerIds or poolProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.