public interface SpeedZoneMapSession extends OsidSession
This session provides methods to retrieve SpeedZone
to
Map
speed zones. A SpeedZone
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 |
canLookupSpeedZoneMapSpeedZones()
Tests if this user can perform lookups of speed zone/map speed zones.
|
IdList |
getMapIdsBySpeedZone(Id speedZoneId)
Gets the
Map Ids mapped to a
SpeedZone. |
MapList |
getMapsBySpeedZone(Id speedZoneId)
Gets the
Maps mapped to a SpeedZone. |
IdList |
getSpeedZoneIdsByMap(Id mapId)
Gets the list of
SpeedZone Ids associated with a
Map. |
IdList |
getSpeedZoneIdsByMaps(IdList mapIds)
Gets the list of
SpeedZone Ids corresponding to a list
of Maps. |
SpeedZoneList |
getSpeedZonesByMap(Id mapId)
Gets the list of
SpeedZones associated with a
Map. |
SpeedZoneList |
getSpeedZonesByMaps(IdList mapIds)
Gets the list of
SpeedZones corresponding to a list of
Maps. |
void |
useComparativeSpeedZoneMapView()
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 |
usePlenarySpeedZoneMapView()
A complete view of the
SpeedZone and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSpeedZoneMapSpeedZones()
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 speed zones is not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeSpeedZoneMapView()
mandatory
- This method is must be implemented. void usePlenarySpeedZoneMapView()
SpeedZone
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 getSpeedZoneIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZone 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. SpeedZoneList getSpeedZonesByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZones
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 getSpeedZoneIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
SpeedZone 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. SpeedZoneList getSpeedZonesByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
SpeedZones
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 getMapIdsBySpeedZone(Id speedZoneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to a
SpeedZone.
speedZoneId
- Id
of a SpeedZone
NotFoundException
- speedZoneId
is not
foundNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsBySpeedZone(Id speedZoneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to a SpeedZone.
speedZoneId
- Id
of a SpeedZone
NotFoundException
- speedZoneId
is not
foundNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.