OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis 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.IddistributorIdthe Id of the Distributor
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTdistributorId is null
CompliancemandatoryThis 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.IddistributorIdthe Id of the Distributor
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENTdistributorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.IddistributorIdthe Id of the Distributor
osid.id.IdprovisionableEnablerIdthe Id of the ProvisionableEnabler
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENTdistributorId or provisionableEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProvisionableEnablerToDistributor
Description

Adds an existing ProvisionableEnabler to a Distributor .

Parametersosid.id.IdprovisionableEnablerIdthe Id of the ProvisionableEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTSprovisionableEnablerId is already assigned to distributorId
NOT_FOUNDprovisionableEnablerId or distributorId not found
NULL_ARGUMENTprovisionableEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProvisionableEnablerFromDistributor
Description

Removes a ProvisionableEnabler from a Distributor .

Parametersosid.id.IdprovisionableEnablerIdthe Id of the ProvisionableEnabler
osid.id.IddistributorIdthe Id of the Distributor
ErrorsNOT_FOUNDprovisionableEnablerId or distributorId not found or provisionableEnablerId not assigned to distributorId
NULL_ARGUMENTprovisionableEnablerId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProvisionableEnablerToDistributor
Description

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

Parametersosid.id.IdprovisionableEnablerIdthe Id of the ProvisionableEnabler
osid.id.IdfromDistributorIdthe Id of the current Distributor
osid.id.IdtoDistributorIdthe Id of the destination Distributor
ErrorsALREADY_EXISTSprovisionableEnablerId already assigned to toDistributorId
NOT_FOUNDprovisionableEnablerId, fromDistributorId , or toDistributorId not found or provisionableEnablerId not mapped to fromDistributorId
NULL_ARGUMENTprovisionableEnablerId, fromDistributorId , or toDistributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.