public interface BrokerProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve BrokerProcessorEnabler
to BrokerProcessor
mappings. A
BrokerProcessor
with multiple BrokerProcessorEnablers
means any positive rule evaluation across the enablers result in
an effective BrokerProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBrokerProcessorEnablerRules()
Tests if this user can perform lookups of broker processor
enabler/broker processor mappings.
|
IdList |
getBrokerProcessorEnablerIdsForBrokerProcessor(Id brokerProcessorId)
Gets the
BrokerProcessorEnabler Id associated with a
BrokerProcessor. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersForBrokerProcessor(Id brokerProcessorId)
Gets the
BrokerProcessorEnabler associated with a
BrokerProcessor. |
IdList |
getBrokerProcessorIdsForBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Gets the
BrokerProcessor Ids mapped to a
BrokerProcessorEnabler. |
BrokerProcessorList |
getBrokerProcessorsForBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Gets the
BrokerProcessors mapped to a
BrokerProcessorEnabler. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useComparativeBrokerProcessorEnablerRuleView()
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 |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryBrokerProcessorEnablerRuleView()
A complete view of the
BrokerProcessorEnabler and
BrokerProcessor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupBrokerProcessorEnablerRules()
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 useComparativeBrokerProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryBrokerProcessorEnablerRuleView()
BrokerProcessorEnabler
and
BrokerProcessor
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. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. IdList getBrokerProcessorEnablerIdsForBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorEnabler Id
associated with a
BrokerProcessor.
brokerProcessorId
- Id
of the
BrokerProcessor
Ids
NotFoundException
- brokerProcessorId
is
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersForBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorEnabler
associated with a
BrokerProcessor.
brokerProcessorId
- Id
of the
BrokerProcessor
NotFoundException
- brokerProcessorId
is
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBrokerProcessorIdsForBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessor
Ids
mapped to a
BrokerProcessorEnabler.
brokerProcessorEnablerId
- Id
of a
BrokerProcessorEnabler
Ids
NotFoundException
- brokerProcessorEnablerId
is not foundNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorList getBrokerProcessorsForBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessors
mapped to a
BrokerProcessorEnabler.
brokerProcessorEnablerId
- Id
of a
BrokerProcessorEnabler
NotFoundException
- brokerProcessorEnablerId
is not foundNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.