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

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

MethodcanAssignPoolConstrainerEnablers
Description

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

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

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdpoolConstrainerEnablerIdthe Id of the PoolConstrainerEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or poolConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPoolConstrainerEnablerToDistributor
Description

Adds an existing PoolConstrainerEnabler to a Distributor.

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

Removes a PoolConstrainerEnabler from a Distributor.

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