public interface SpeedZoneEnablerMapSession extends OsidSession
This session provides methods to retrieve SpeedZoneEnabler
to Map
mappings. a SpeedZoneEnabler
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 |
canLookupSpeedZoneEnablerMapMappings()
Tests if this user can perform lookups of speed zone enabler/map
mappings.
|
IdList |
getMapIdsBySpeedZoneEnabler(Id speedZoneEnablerId)
Gets the
Map Ids mapped to a
SpeedZoneEnabler. |
MapList |
getMapsBySpeedZoneEnabler(Id speedZoneEnablerId)
Gets the
Maps mapped to a SpeedZoneEnabler. |
IdList |
getSpeedZoneEnablerIdsByMap(Id mapId)
Gets the list of
SpeedZoneEnablerIds associated with an
Map. |
IdList |
getSpeedZoneEnablerIdsByMaps(IdList mapIds)
Gets the list of
SpeedZoneEnabler Ids corresponding to
a list of Maps. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByMap(Id mapId)
Gets the list of speed zone enablers associated with an
Map. |
SpeedZoneEnablerList |
getSpeedZoneEnablersByMaps(IdList mapIds)
Gets the list of speed zone enablers corresponding to a list of
Maps. |
void |
useComparativeSpeedZoneEnablerMapView()
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 |
usePlenarySpeedZoneEnablerMapView()
A complete view of the
SpeedZoneEnabler and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSpeedZoneEnablerMapMappings()
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 useComparativeSpeedZoneEnablerMapView()
mandatory
- This method is must be implemented. void usePlenarySpeedZoneEnablerMapView()
SpeedZoneEnabler
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 getSpeedZoneEnablerIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnablerIds
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. SpeedZoneEnablerList getSpeedZoneEnablersByMap(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 getSpeedZoneEnablerIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
SpeedZoneEnabler 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. SpeedZoneEnablerList getSpeedZoneEnablersByMaps(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 getMapIdsBySpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to a
SpeedZoneEnabler.
speedZoneEnablerId
- Id
of a
SpeedZoneEnabler
NotFoundException
- speedZoneEnablerId
is not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsBySpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to a SpeedZoneEnabler.
speedZoneEnablerId
- Id
of a
SpeedZoneEnabler
NotFoundException
- speedZoneEnablerId
is not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.