public interface ObstacleEnablerMapSession extends OsidSession
This session provides methods to retrieve ObstacleEnabler
to Map
mappings. An ObstacleEnabler
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 |
canLookupObstacleEnablerMapMappings()
Tests if this user can perform lookups of obstacle enabler/map
mappings.
|
IdList |
getMapIdsByObstacleEnabler(Id obstacleEnablerId)
Gets the
Map Ids mapped to an
ObstacleEnabler. |
MapList |
getMapsByObstacleEnabler(Id obstacleEnablerId)
Gets the
Maps mapped to an ObstacleEnabler. |
IdList |
getObstacleEnablerIdsByMap(Id mapId)
Gets the list of
ObstacleEnablerIds associated with an
Map. |
IdList |
getObstacleEnablerIdsByMaps(IdList mapIds)
Gets the list of
ObstacleEnabler Ids corresponding to a
list of Maps. |
ObstacleEnablerList |
getObstacleEnablersByMap(Id mapId)
Gets the list of obstacle enabler associated with an
Map. |
ObstacleEnablerList |
getObstacleEnablersByMaps(IdList mapIds)
Gets the list of obstacle enabler corresponding to a list of
Maps. |
void |
useComparativeObstacleEnablerMapView()
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 |
usePlenaryObstacleEnablerMapView()
A complete view of the
ObstacleEnabler and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupObstacleEnablerMapMappings()
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 useComparativeObstacleEnablerMapView()
mandatory
- This method is must be implemented. void usePlenaryObstacleEnablerMapView()
ObstacleEnabler
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 getObstacleEnablerIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnablerIds
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. ObstacleEnablerList getObstacleEnablersByMap(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 getObstacleEnablerIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
ObstacleEnabler 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. ObstacleEnablerList getObstacleEnablersByMaps(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 getMapIdsByObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to an
ObstacleEnabler.
obstacleEnablerId
- Id
of an
ObstacleEnabler
NotFoundException
- obstacleEnablerId
is
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsByObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to an ObstacleEnabler.
obstacleEnablerId
- Id
of an
ObstacleEnabler
NotFoundException
- obstacleEnablerId
is
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.