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

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

Tests if this user can perform lookups of pool constrainer enabler/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.
MethoduseComparativePoolConstrainerEnablerDistributorView
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.
MethodusePlenaryPoolConstrainerEnablerDistributorView
Description

A complete view of the PoolConstrainerEnabler 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.
MethodgetPoolConstrainerEnablerIdsByDistributor
Description

Gets the list of PoolConstrainerEnablerIds associated with a Distributor.

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

Gets the list of pool constrainer enablers associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.provisioning.rules.PoolConstrainerEnablerListlist of related pool constrainer enablers
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerIdsByDistributors
Description

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

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

Gets the list of pool constrainer enablers corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.provisioning.rules.PoolConstrainerEnablerListlist of pool constrainer enablers
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorIdsByPoolConstrainerEnabler
Description

Gets the Distributor Ids mapped to a PoolConstrainerEnabler.

Parametersosid.id.IdpoolConstrainerEnablerId Id of a PoolConstrainerEnabler
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND poolConstrainerEnablerId is not found
NULL_ARGUMENT poolConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByPoolConstrainerEnabler
Description

Gets the Distributors mapped to a PoolConstrainerEnabler.

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