public interface SignalEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve SignalEnabler
to Signal
mappings. A Signal
with multiple
SignalEnablers
means any positive rule evaluation across
the enablers result in an enabled Signal.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSignalEnablerRules()
Tests if this user can perform lookups of signal enabler/signal
mappings.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
IdList |
getSignalEnablerIdsForSignal(Id signalId)
Gets the
SignalEnabler Id associated with a
Signal. |
SignalEnablerList |
getSignalEnablersForSignal(Id signalId)
Gets the
SignalEnabler associated with a Signal. |
IdList |
getSignalIdsForSignalEnabler(Id signalEnablerId)
Gets the
Signal Ids mapped to a
SignalEnabler. |
SignalList |
getSignalsForSignalEnabler(Id signalEnablerId)
Gets the
Signals mapped to a SignalEnabler. |
void |
useComparativeSignalEnablerRuleView()
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 |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenarySignalEnablerRuleView()
A complete view of the
SignalEnabler and Signal
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSignalEnablerRules()
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 useComparativeSignalEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenarySignalEnablerRuleView()
SignalEnabler
and Signal
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 useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. IdList getSignalEnablerIdsForSignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnabler Id
associated with a
Signal.
signalId
- Id
of the Signal
Ids
NotFoundException
- signalId
is not
foundNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalEnablerList getSignalEnablersForSignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnabler
associated with a Signal.
signalId
- Id
of the Signal
NotFoundException
- signalId
is not
foundNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSignalIdsForSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signal
Ids
mapped to a
SignalEnabler.
signalEnablerId
- Id
of a SignalEnabler
Ids
NotFoundException
- signalEnablerId
is
not foundNullArgumentException
- signalEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsForSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signals
mapped to a SignalEnabler.
signalEnablerId
- Id
of a SignalEnabler
NotFoundException
- signalEnablerId
is
not foundNullArgumentException
- signalEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.