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

This session provides methods to retrieve Provisionable to Distributor provisionables. A Provisionable may appear in multiple Distributor objects. Each distributor may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupProvisionableDistributorProvisionables
Description

Tests if this user can perform lookups of provisionable/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up provisionables is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProvisionableDistributorView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProvisionableDistributorView
Description

A complete view of the Provisionable and Distributor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetProvisionableIdsByDistributor
Description

Gets the list of Provisionable Ids associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.id.IdListlist of related provisionable Ids
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProvisionablesByDistributor
Description

Gets the list of Provisionables associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.provisioning.ProvisionableListlist of related provisionables
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableIdsByDistributors
Description

Gets the list of Provisionable Ids corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.id.IdListlist of provisionable Ids
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProvisionablesByDistributors
Description

Gets the list of Provisionables corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.provisioning.ProvisionableListlist of provisionables
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorIdsByProvisionable
Description

Gets the Distributor Ids mapped to a Provisionable.

Parametersosid.id.IdprovisionableId Id of a Provisionable
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND provisionableId is not found
NULL_ARGUMENT provisionableId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByProvisionable
Description

Gets the Distributors mapped to a Provisionable.

Parametersosid.id.IdprovisionableId Id of a Provisionable
Returnosid.provisioning.DistributorListlist of distributors
ErrorsNOT_FOUND provisionableId is not found
NULL_ARGUMENT provisionableId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.