OSID Logo
OSID Specifications
provisioning rules package
Version 3.1.0
Interfaceosid.provisioning.rules.PoolConstrainerEnablerDistributorAssignmentSession
Implementsosid.OsidSession
Used Byosid.provisioning.rules.ProvisioningRulesManager
osid.provisioning.rules.ProvisioningRulesProxyManager
Description

This session provides methods to re-assign PoolConstrainerEnabler to Distributor mappings. A PoolConstrainerEnabler may appear in multiple Distributor catalogs 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignPoolConstrainerEnablerToDistributor
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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IddistributorId the Id of the Distributor
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT distributorId is null
Compliancemandatory This 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.IddistributorId the Id of the Distributor
Returnosid.id.IdList list of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IddistributorId the Id of the Distributor
osid.id.IdpoolConstrainerEnablerId the Id of the PoolConstrainerEnabler
Returnosid.id.IdList list of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or poolConstrainerEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignPoolConstrainerEnablerToDistributor
Description

Adds an existing PoolConstrainerEnabler to a Distributor.

Parametersosid.id.IdpoolConstrainerEnablerId the Id of the PoolConstrainerEnabler
osid.id.IddistributorId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignPoolConstrainerEnablerFromDistributor
Description

Removes a PoolConstrainerEnabler from a Distributor.

Parametersosid.id.IdpoolConstrainerEnablerId the Id of the PoolConstraienrEnabler
osid.id.IddistributorId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignPoolConstrainerEnablerToDistributor
Description

Moves a PoolConstrainerEnabler from one Distributor to another. Mappings to other Distributors are unaffected.

Parametersosid.id.IdpoolConstrainerEnablerId the Id of the PoolConstrainerEnabler
osid.id.IdfromDistributorId the Id of the current Distributor
osid.id.IdtoDistributorId the Id of the destination Distributor
ErrorsALREADY_EXISTS poolConstrainerEnablerId already assigned to toDistributorId
NOT_FOUND poolConstrainerEnablerId, fromDistributorId, or toDistributorId not found or poolConstrainerEnablerId not mapped to fromDistributorId
NULL_ARGUMENT poolConstrainerEnablerId, fromDistributorId, or toDistributorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.