public interface PathMapSession extends OsidSession
This session provides methods to retrieve Path
to
Map
mappings. A Path
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 |
canLookupPathMapLocations()
Tests if this user can perform lookups of path/map mappings.
|
IdList |
getMapIdsByPath(Id pathId)
Gets the
Map Ids mapped to a
Path. |
MapList |
getMapsByPath(Id pathId)
Gets the
Maps mapped to a Path. |
IdList |
getPathIdsByMap(Id mapId)
Gets the list of
Path Ids associated with a Map. |
IdList |
getPathIdsByMaps(IdList mapIds)
Gets the list of
Path Ids corresponding to a list of
Maps. |
PathList |
getPathsByMap(Id mapId)
Gets the list of
Paths associated with a Map. |
PathList |
getPathsByMaps(IdList mapIds)
Gets the list of
Path corresponding to a list of
Maps. |
void |
useComparativePathMapView()
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 |
usePlenaryPathMapView()
A complete view of the
Path and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPathMapLocations()
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 useComparativePathMapView()
mandatory
- This method is must be implemented. void usePlenaryPathMapView()
Path
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 getPathIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Path 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. PathList getPathsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Paths
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 getPathIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Path 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. PathList getPathsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Path
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 getMapIdsByPath(Id pathId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to a
Path.
pathId
- Id
of a Path
NotFoundException
- pathId
is not foundNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsByPath(Id pathId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to a Path.
pathId
- Id
of a Path
NotFoundException
- pathId
is not foundNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.