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

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

MethodcanAssignRequests
Description

Tests if this user can alter request/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known provisionable 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignRequestsToDistributor
Description

Tests if this user can alter request/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known provisionable 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 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 request 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.
MethodgetAssignableDistributorIdsForRequest
Description

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

Parametersosid.id.IddistributorIdthe Id of the Distributor
osid.id.IdrequestIdthe Id of the Request
Returnosid.id.IdListlist of assignable distributor Ids
ErrorsNULL_ARGUMENT distributorId or requestId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRequestToDistributor
Description

Adds an existing Request to a Distributor.

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

Removes a Request from a Distributor.

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