public interface BrokerConstrainerEnablerDistributorSession extends OsidSession
This session provides methods to retrieve
BrokerConstrainerEnabler
to Distributor
mappings. A
BrokerConstrainerEnabler
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 |
canLookupBrokerConstrainerEnablerDistributorMappings()
Tests if this user can perform lookups of broker constrainer
enabler/distributor mappings.
|
IdList |
getBrokerConstrainerEnablerIdsByDistributor(Id distributorId)
Gets the list of
BrokerConstrainerEnablerIds associated
with a Distributor. |
IdList |
getBrokerConstrainerEnablerIdsByDistributors(IdList distributorIds)
Gets the list of
BrokerConstrainerEnabler Ids
corresponding to a list of Distributors. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByDistributor(Id distributorId)
Gets the list of broker constrainer enablers associated with a
Distributor. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByDistributors(IdList distributorIds)
Gets the list of broker constrainer enablers corresponding to a list
of
Distributors. |
IdList |
getDistributorIdsByBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
Gets the
Distributor Ids mapped to a
BrokerConstrainerEnabler. |
DistributorList |
getDistributorsByBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
Gets the
Distributors mapped to a
BrokerConstrainerEnabler. |
void |
useComparativeBrokerConstrainerEnablerDistributorView()
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 |
usePlenaryBrokerConstrainerEnablerDistributorView()
A complete view of the
BrokerConstrainerEnabler and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBrokerConstrainerEnablerDistributorMappings()
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 useComparativeBrokerConstrainerEnablerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryBrokerConstrainerEnablerDistributorView()
BrokerConstrainerEnabler
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 getBrokerConstrainerEnablerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerIds
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. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByDistributor(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 getBrokerConstrainerEnablerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnabler 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. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByDistributors(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 getDistributorIdsByBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
BrokerConstrainerEnabler.
brokerConstrainerEnablerId
- Id
of a
BrokerConstrainerEnabler
NotFoundException
- brokerConstrainerEnablerId
is not foundNullArgumentException
-
brokerConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
BrokerConstrainerEnabler.
brokerConstrainerEnablerId
- Id
of a
BrokerConstrainerEnabler
NotFoundException
- brokerConstrainerEnablerId
is not foundNullArgumentException
-
brokerConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.