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

This session provides methods to re-assign PoolProcessorEnabler to Distributor mappings. A PoolProcessorEnabler may appear in multiple Distributor objects and removing the last reference to a PoolProcessorEnabler is the equivalent of deleting it. Each Distributor may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a PoolProcessorEnabler to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignPoolProcessorEnablers
Description

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

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIds
Description

Gets a list of distributors including and under the given distributor node in which any pool processor enabler can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableDistributorIdsForPoolProcessorEnabler
Description

Gets a list of distributors including and under the given distributor node in which a specific pool processor enabler can be assigned.

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or poolProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPoolProcessorEnablerToDistributor
Description

Adds a existing PoolProcessorEnabler to a Distributor.

Parametersosid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTS poolProcessorEnablerId is already assigned to distributorId
NOT_FOUND poolProcessorEnablerId or distributorId not found
NULL_ARGUMENT poolProcessorEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPoolProcessorEnablerFromDistributor
Description

Removes a PoolProcessorEnabler from a Distributor.

Parametersosid.id.IdpoolProcessorEnablerIdthe Id of the PoolProcessorEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsNOT_FOUND poolProcessorEnablerId or distributorId not found or poolProcessorEnablerId not assigned to distributorId
NULL_ARGUMENT poolProcessorEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.