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

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

MethodcanAssignProvisions
Description

Tests if this user can alter provision/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 provisioning is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignProvisionsToDistributor
Description

Tests if this user can alter provision/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 provisioning 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 provision 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.
MethodgetAssignableDistributorIdsForProvision
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdprovisionIdthe Id of the Provision
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or provisionId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProvisionToDistributor
Description

Adds an existing Provision to a Distributor.

Parametersosid.id.IdprovisionIdthe Id of the Provision
osid.id.IddistributorIdthe Id of the Distributor
ErrorsALREADY_EXISTS provisionId is slready assigned to distributorId
NOT_FOUND provisionId or distributorId not found
NULL_ARGUMENT provisionId or distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProvisionFromDistributor
Description

Removes a Provision from a Distributor.

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