public interface BrokerProcessorDistributorSession extends OsidSession
This session provides methods to retrieve BrokerProcessor
to Distributor
mappings. A BrokerProcessor
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 |
canLookupBrokerProcessorDistributorMappings()
Tests if this user can perform lookups of broker processor/distributor
mappings.
|
IdList |
getBrokerProcessorIdsByDistributor(Id distributorId)
Gets the list of
BrokerProcessorIds associated with a
Distributor. |
IdList |
getBrokerProcessorIdsByDistributors(IdList distributorIds)
Gets the list of
BrokerProcessor Ids corresponding to a
list of Distributors. |
BrokerProcessorList |
getBrokerProcessorsByDistributor(Id distributorId)
Gets the list of broker processors associated with a
Distributor. |
BrokerProcessorList |
getBrokerProcessorsByDistributors(IdList distributorIds)
Gets the list of broker processor corresponding to a list of
Distributors. |
IdList |
getDistributorIdsByBrokerProcessor(Id brokerProcessorId)
Gets the
Distributor Ids mapped to a
BrokerProcessor. |
DistributorList |
getDistributorsByBrokerProcessor(Id brokerProcessorId)
Gets the
Distributors mapped to a
BrokerProcessor. |
void |
useComparativeBrokerProcessorDistributorView()
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 |
usePlenaryBrokerProcessorDistributorView()
A complete view of the
BrokerProcessor and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBrokerProcessorDistributorMappings()
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 useComparativeBrokerProcessorDistributorView()
mandatory
- This method is must be implemented. void usePlenaryBrokerProcessorDistributorView()
BrokerProcessor
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 getBrokerProcessorIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorIds
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. BrokerProcessorList getBrokerProcessorsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getBrokerProcessorIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
BrokerProcessor 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. BrokerProcessorList getBrokerProcessorsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
BrokerProcessor.
brokerProcessorId
- Id
of a
BrokerProcessor
NotFoundException
- brokerProcessorId
is
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
BrokerProcessor.
brokerProcessorId
- Id
of a
BrokerProcessor
NotFoundException
- brokerProcessorId
is
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.