public interface BrokerConstrainerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve
BrokerConstrainerEnabler
to BrokerConstrainer
mappings. A BrokerConstrainer
with multiple
BrokerConstrainerEnablers
means any positive rule evaluation
across the enablers result in an effective BrokerConstrainer.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBrokerConstrainerEnablerRules()
Tests if this user can perform lookups of broker constrainer
enabler/broker constrainer mappings.
|
IdList |
getBrokerConstrainerEnablerIdsForBrokerConstrainer(Id brokerConstrainerId)
Gets the
BrokerConstrainerEnabler Id associated with a
BrokerConstrainer. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersForBrokerConstrainer(Id brokerConstrainerId)
Gets the
BrokerConstrainerEnablers associated with a
BrokerConstrainer. |
IdList |
getBrokerConstrainerIdsForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
Gets the
BrokerConstrainer Ids mapped to
a BrokerConstrainerEnabler. |
BrokerConstrainerList |
getBrokerConstrainersForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
Gets the
BrokerConstrainers mapped to a
BrokerConstrainerEnabler. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useComparativeBrokerConstrainerEnablerRuleView()
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 |
usePlenaryBrokerConstrainerEnablerRuleView()
A complete view of the
BrokerConstrainerEnabler and
BrokerConstrainer 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 canLookupBrokerConstrainerEnablerRules()
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 useComparativeBrokerConstrainerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryBrokerConstrainerEnablerRuleView()
BrokerConstrainerEnabler
and
BrokerConstrainer
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 getBrokerConstrainerEnablerIdsForBrokerConstrainer(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnabler Id
associated with a
BrokerConstrainer.
brokerConstrainerId
- Id
of the
BrokerConstrainer
Ids
NotFoundException
- brokerConstrainerId
is not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersForBrokerConstrainer(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablers
associated with a
BrokerConstrainer.
brokerConstrainerId
- Id
of the
BrokerConstrainer
NotFoundException
- brokerConstrainerId
is not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBrokerConstrainerIdsForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainer
Ids
mapped to
a BrokerConstrainerEnabler.
brokerConstrainerEnablerId
- Id
of a
BrokerConstrainerEnabler
Ids
NotFoundException
- brokerConstrainerEnablerId
is not foundNullArgumentException
-
brokerConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerList getBrokerConstrainersForBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainers
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.