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

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

MethodcanAssignPools
Description

Tests if this user can alter pool/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 assignment operations to unauthorized users.

Returnboolean false if pool assignment is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignPoolsToDistributor
Description

Tests if this user can alter pool/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 assignment operations to unauthorized users.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnboolean false if pool assignment 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 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.
MethodgetAssignableDistributorIdsForPool
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdpoolIdthe Id of the Pool
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or poolId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPoolToDistributor
Description

Adds an existing Pool to a Distributor.

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

Removes a Pool from a Distributor.

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