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:
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBrokerConstrainerDistributorMappings()
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 useComparativeBrokerConstrainerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryBrokerConstrainerDistributorView()
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.mandatory
- This method is must be implemented. IdList getBrokerConstrainerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerIds
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. BrokerConstrainerList getBrokerConstrainersByDistributor(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 getBrokerConstrainerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
BrokerConstrainer 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. BrokerConstrainerList getBrokerConstrainersByDistributors(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 getDistributorIdsByBrokerConstrainer(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
BrokerConstrainer.
brokerConstrainerId
- Id
of a
BrokerConstrainer
NotFoundException
- brokerConstrainerId
is not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByBrokerConstrainer(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
BrokerConstrainer.
brokerConstrainerId
- Id
of a
BrokerConstrainer
NotFoundException
- brokerConstrainerId
is not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.