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

This session provides methods to retrieve Pool to Distributor mappings. A Pool 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
MethodcanLookupPoolDistributorMappings
Description

Tests if this user can perform lookups of pool/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 mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePoolDistributorView
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.
MethodusePlenaryPoolDistributorView
Description

A complete view of the Pool 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.
MethodgetPoolIdsByDistributor
Description

Gets the list of Pool Ids associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.id.IdListlist of related pool 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.
MethodgetPoolsByDistributor
Description

Gets the list of Pools associated with a Distributor.

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

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

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

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

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

Gets the Distributor Ids mapped to a Pool.

Parametersosid.id.IdpoolId Id of a Pool
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND poolId is not found
NULL_ARGUMENT poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByPool
Description

Gets the Distributors mapped to a Pool.

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