public interface SignalMapSession extends OsidSession
This session provides methods to retrieve Signal
to
Map
signals. A Signal
may appear in multiple
Map
objects. Each map 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 |
canLookupSignalMapSignals()
Tests if this user can perform lookups of signal/map signals.
|
IdList |
getMapIdsBySignal(Id signalId)
Gets the
Map Ids mapped to a
Signal. |
MapList |
getMapsBySignal(Id signalId)
Gets the
Maps mapped to a Signal. |
IdList |
getSignalIdsByMap(Id mapId)
Gets the list of
Signal Ids associated with a
Map. |
IdList |
getSignalIdsByMaps(IdList mapIds)
Gets the list of
Signal Ids corresponding to a list of
Maps. |
SignalList |
getSignalsByMap(Id mapId)
Gets the list of
Signals associated with a Map. |
SignalList |
getSignalsByMaps(IdList mapIds)
Gets the list of
Signals corresponding to a list of
Maps. |
void |
useComparativeSignalMapView()
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 |
usePlenarySignalMapView()
A complete view of the
Signal and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSignalMapSignals()
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 signals is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSignalMapView()
mandatory
- This method is must be implemented. void usePlenarySignalMapView()
Signal
and Map
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 getSignalIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signal Ids
associated with a
Map.
mapId
- Id
of the Map
Ids
NotFoundException
- mapId
is not foundNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Signals
associated with a Map.
mapId
- Id
of the Map
NotFoundException
- mapId
is not foundNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSignalIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Signal Ids
corresponding to a list of
Maps.
mapIds
- list of map Ids
Ids
NullArgumentException
- mapIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SignalList getSignalsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Signals
corresponding to a list of
Maps.
mapIds
- list of map Ids
NullArgumentException
- mapIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getMapIdsBySignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to a
Signal.
signalId
- Id
of a Signal
NotFoundException
- signalId
is not
foundNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsBySignal(Id signalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to a Signal.
signalId
- Id
of a Signal
NotFoundException
- signalId
is not
foundNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.