public interface ObstacleMapSession extends OsidSession
This session provides methods to retrieve Obstacle
to
Map
mappings. An Obstacle
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 |
canLookupObstacleMapObstacles()
Tests if this user can perform lookups of obstacle/map mappings.
|
IdList |
getMapIdsByObstacle(Id obstacleId)
Gets the
Map Ids mapped an an
Obstacle. |
MapList |
getMapsByObstacle(Id obstacleId)
Gets the
Maps mapped to an Obstacle. |
IdList |
getObstacleIdsByMap(Id mapId)
Gets the list of
Obstacle Ids associated with a
Map. |
IdList |
getObstacleIdsByMaps(IdList mapIds)
Gets the list of
Obstacle Ids corresponding to a list
of Maps. |
ObstacleList |
getObstaclesByMap(Id mapId)
Gets the list of
Obstacles associated with a
Map. |
ObstacleList |
getObstaclesByMaps(IdList mapIds)
Gets the list of
Obstacles corresponding to a list of
Maps. |
void |
useComparativeObstacleMapView()
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 |
usePlenaryObstacleMapView()
A complete view of the
Obstacle and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupObstacleMapObstacles()
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 useComparativeObstacleMapView()
mandatory
- This method is must be implemented. void usePlenaryObstacleMapView()
Obstacle
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 getObstacleIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Obstacle 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. ObstacleList getObstaclesByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Obstacles
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 getObstacleIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Obstacle 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. ObstacleList getObstaclesByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Obstacles
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 getMapIdsByObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped an an
Obstacle.
obstacleId
- Id
of an Obstacle
NotFoundException
- obstacleId
is not
foundNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsByObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to an Obstacle.
obstacleId
- Id
of an Obstacle
NotFoundException
- obstacleId
is not
foundNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.