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

This session provides methods to re-assign PoolConstrainer to Distributor mappings. A PoolConstrainer may appear in multiple Distributor objects and removing the last reference to a PoolConstrainer 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 PoolConstrainer to another Distributor is not a copy operation (eg: does not change its Id ).

MethodcanAssignPoolConstrainers
Description

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

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

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdpoolConstrainerIdthe Id of the PoolConstrainer
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or poolConstrainerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPoolConstrainerToDistributor
Description

Adds an existing PoolConstrainer to a Distributor.

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

Removes a PoolConstrainer from a Distributor.

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