public interface IntersectionMapSession extends OsidSession
This session provides methods to retrieve Intersection
to Map
mappings. An Intersection
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 |
canLookupIntersectionMapLocations()
Tests if this user can perform lookups of intersection/map mappings.
|
IdList |
getIntersectionIdsByMap(Id mapId)
Gets the list of
Intersection Ids associated with a
Map. |
IdList |
getIntersectionIdsByMaps(IdList mapIds)
Gets the list of
Intersection Ids corresponding to a
list of Maps. |
IntersectionList |
getIntersectionsByMap(Id mapId)
Gets the list of
Intersections associated with a
Map. |
IntersectionList |
getIntersectionsByMaps(IdList mapIds)
Gets the list of
Intersection corresponding to a list
of Maps. |
IdList |
getMapIdsByIntersection(Id intersectionId)
Gets the
Map Ids mapped to an
Intersection. |
MapList |
getMapsByIntersection(Id intersectionId)
Gets the
Maps mapped to an Intersection. |
void |
useComparativeIntersectionMapView()
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 |
usePlenaryIntersectionMapView()
A complete view of the
Intersection and Map
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupIntersectionMapLocations()
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 useComparativeIntersectionMapView()
mandatory
- This method is must be implemented. void usePlenaryIntersectionMapView()
Intersection
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 getIntersectionIdsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Intersection 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. IntersectionList getIntersectionsByMap(Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Intersections
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 getIntersectionIdsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Intersection 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. IntersectionList getIntersectionsByMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Intersection
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 getMapIdsByIntersection(Id intersectionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Map
Ids
mapped to an
Intersection.
intersectionId
- Id
of an Intersection
NotFoundException
- intersectionId
is
not foundNullArgumentException
- intersectionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapList getMapsByIntersection(Id intersectionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Maps
mapped to an Intersection.
intersectionId
- Id
of an Intersection
NotFoundException
- intersectionId
is
not foundNullArgumentException
- intersectionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.