public interface BrokerDistributorSession extends OsidSession
This session provides methods to retrieve Broker
to
Distributor
mappings. A Broker
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBrokerDistributorMappings()
Tests if this user can perform lookups of broker/distributor mappings.
|
IdList |
getBrokerIdsByDistributor(Id distributorId)
Gets the list of
Broker Ids associated with a
Distributor. |
IdList |
getBrokerIdsByDistributors(IdList distributorIds)
Gets the list of
Broker Ids corresponding to a list of
Distributors. |
BrokerList |
getBrokersByDistributor(Id distributorId)
Gets the list of
Brokers associated with a
Distributor. |
BrokerList |
getBrokersByDistributors(IdList distributorIds)
Gets the list of
Broker corresponding to a list of
Distributors. |
IdList |
getDistributorIdsByBroker(Id brokerId)
Gets the
Distributor Ids mapped to a
Broker. |
DistributorList |
getDistributorsByBroker(Id brokerId)
Gets the
Distributors mapped to a Broker. |
void |
useComparativeBrokerDistributorView()
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 |
usePlenaryBrokerDistributorView()
A complete view of the
Broker and Distributor
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBrokerDistributorMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBrokerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryBrokerDistributorView()
Broker
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.mandatory
- This method is must be implemented. IdList getBrokerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Broker Ids
associated with a
Distributor.
distributorId
- Id
of the Distributor
Ids
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerList getBrokersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Brokers
associated with a
Distributor.
distributorId
- Id
of the Distributor
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBrokerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Broker Ids
corresponding to a list of
Distributors.
distributorIds
- list of distributor Ids
Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerList getBrokersByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Broker
corresponding to a list of
Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
Broker.
brokerId
- Id
of a Broker
NotFoundException
- brokerId
is not
foundNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByBroker(Id brokerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a Broker.
brokerId
- Id
of a Broker
NotFoundException
- brokerId
is not
foundNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.