public interface SignalEnablerMapSession extends OsidSession
This session provides methods to retrieve SignalEnabler
to Map
mappings. A SignalEnabler
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 |
canLookupSignalEnablerMapMappings()
Tests if this user can perform lookups of signal enabler/map mappings.
|
IdList |
getMapIdsBySignalEnabler(Id signalEnablerId)
Gets the
Map Ids mapped to a
SignalEnabler. |
MapList |
getMapsBySignalEnabler(Id signalEnablerId)
Gets the
Maps mapped to a SignalEnabler. |
IdList |
getSignalEnablerIdsByMap(Id mapId)
Gets the list of
SignalEnablerIds associated with an
Map. |
IdList |
getSignalEnablerIdsByMaps(IdList mapIds)
Gets the list of
SignalEnabler Ids corresponding to a
list of Maps. |
SignalEnablerList |
getSignalEnablersByMap(Id mapId)
Gets the list of signal enabler associated with an
Map. |
SignalEnablerList |
getSignalEnablersByMaps(IdList mapIds)
Gets the list of signal enabler corresponding to a list of
Maps. |
void |
useComparativeSignalEnablerMapView()
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 |
usePlenarySignalEnablerMapView()
A complete view of the
SignalEnabler and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSignalEnablerMapMappings()
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 useComparativeSignalEnablerMapView()
mandatory
- This method is must be implemented. void usePlenarySignalEnablerMapView()
SignalEnabler
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 getSignalEnablerIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnablerIds
associated with an
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. SignalEnablerList getSignalEnablersByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getSignalEnablerIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
SignalEnabler 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. SignalEnablerList getSignalEnablersByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Maps.
mapIds
- list of map Ids
NullArgumentException
- mapIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getMapIdsBySignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
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. MapList getMapsBySignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
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.