org.osid.provisioning.rules

Interface BrokerConstrainerDistributorSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BrokerConstrainerDistributorSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBrokerConstrainerDistributorMappings() Tests if this user can perform lookups of broker constrainer/distributor mappings.
IdList	getBrokerConstrainerIdsByDistributor(Id distributorId) Gets the list of BrokerConstrainerIds associated with a Distributor.
IdList	getBrokerConstrainerIdsByDistributors(IdList distributorIds) Gets the list of BrokerConstrainer Ids corresponding to a list of Distributors.
BrokerConstrainerList	getBrokerConstrainersByDistributor(Id distributorId) Gets the list of broker constrainer associated with a Distributor.
BrokerConstrainerList	getBrokerConstrainersByDistributors(IdList distributorIds) Gets the list of broker constrainer corresponding to a list of Distributors.
IdList	getDistributorIdsByBrokerConstrainer(Id brokerConstrainerId) Gets the Distributor Ids mapped to a BrokerConstrainer.
DistributorList	getDistributorsByBrokerConstrainer(Id brokerConstrainerId) Gets the Distributors mapped to a BrokerConstrainer.
void	useComparativeBrokerConstrainerDistributorView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBrokerConstrainerDistributorView() A complete view of the BrokerConstrainer and Distributor returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupBrokerConstrainerDistributorMappings

boolean canLookupBrokerConstrainerDistributorMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBrokerConstrainerDistributorView

void useComparativeBrokerConstrainerDistributorView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBrokerConstrainerDistributorView

void usePlenaryBrokerConstrainerDistributorView()

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.

Compliance:

mandatory - This method is must be implemented.

getBrokerConstrainerIdsByDistributor

IdList getBrokerConstrainerIdsByDistributor(Id distributorId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the list of BrokerConstrainerIds associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related broker constrainer Ids

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainersByDistributor

BrokerConstrainerList getBrokerConstrainersByDistributor(Id distributorId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the list of broker constrainer associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related broker constrainers

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerIdsByDistributors

IdList getBrokerConstrainerIdsByDistributors(IdList distributorIds)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of broker constrainer Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainersByDistributors

BrokerConstrainerList getBrokerConstrainersByDistributors(IdList distributorIds)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of broker constrainers

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByBrokerConstrainer

IdList getDistributorIdsByBrokerConstrainer(Id brokerConstrainerId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the Distributor Ids mapped to a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of a BrokerConstrainer

Returns:

list of distributors

Throws:

NotFoundException - brokerConstrainerId is not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByBrokerConstrainer

DistributorList getDistributorsByBrokerConstrainer(Id brokerConstrainerId)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets the Distributors mapped to a BrokerConstrainer.

Parameters:

brokerConstrainerId - Id of a BrokerConstrainer

Returns:

list of distributors

Throws:

NotFoundException - brokerConstrainerId is not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.