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

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

Tests if this user can perform lookups of broker constrainer/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.
MethoduseComparativeBrokerConstrainerDistributorView
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.
MethodusePlenaryBrokerConstrainerDistributorView
Description

A complete view of the BrokerConstrainer 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.
MethodgetBrokerConstrainerIdsByDistributor
Description

Gets the list of BrokerConstrainerIds associated with a Distributor.

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

Gets the list of broker constrainer associated with a Distributor.

Parametersosid.id.IddistributorId Id of the Distributor
Returnosid.provisioning.rules.BrokerConstrainerListlist of related broker constrainers
ErrorsNOT_FOUND distributorId is not found
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerIdsByDistributors
Description

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

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

Gets the list of broker constrainer corresponding to a list of Distributors.

Parametersosid.id.IdListdistributorIdslist of distributor Ids
Returnosid.provisioning.rules.BrokerConstrainerListlist of broker constrainers
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorIdsByBrokerConstrainer
Description

Gets the Distributor Ids mapped to a BrokerConstrainer.

Parametersosid.id.IdbrokerConstrainerId Id of a BrokerConstrainer
Returnosid.id.IdListlist of distributors
ErrorsNOT_FOUND brokerConstrainerId is not found
NULL_ARGUMENT brokerConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorsByBrokerConstrainer
Description

Gets the Distributors mapped to a BrokerConstrainer.

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