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

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

MethodcanAssignProvisionableEnablers
Description

Tests if this user can alter provisionable 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.
MethodcanAssignProvisionableEnablerToDistributor
Description

Tests if this user can alter provisionable 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 provisionable 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.
MethodgetAssignableDistributorIdsForProvisionableEnabler
Description

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

Parametersosid.id.IddistributorId the Id of the Distributor
osid.id.IdprovisionableEnablerId the Id of the ProvisionableEnabler
Returnosid.id.IdList list of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or provisionableEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignProvisionableEnablerToDistributor
Description

Adds an existing ProvisionableEnabler to a Distributor.

Parametersosid.id.IdprovisionableEnablerId the Id of the ProvisionableEnabler
osid.id.IddistributorId the Id of the Distributor
ErrorsALREADY_EXISTS provisionableEnablerId is already assigned to distributorId
NOT_FOUND provisionableEnablerId or distributorId not found
NULL_ARGUMENT provisionableEnablerId or distributorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignProvisionableEnablerFromDistributor
Description

Removes a ProvisionableEnabler from a Distributor.

Parametersosid.id.IdprovisionableEnablerId the Id of the ProvisionableEnabler
osid.id.IddistributorId the Id of the Distributor
ErrorsNOT_FOUND provisionableEnablerId or distributorId not found or provisionableEnablerId not assigned to distributorId
NULL_ARGUMENT provisionableEnablerId or distributorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignProvisionableEnablerToDistributor
Description

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

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