public interface ObstacleLookupSession extends OsidSession
This session defines methods for retrieving obstacle.
This lookup session defines several views:
Obstacles
with the ObstacleAdminSession.
The methods useFederatedMapView()
and
useIsolatedMapView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Obstacles may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Obstacles.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupObstacles()
Tests if this user can perform
Obstacle lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
Obstacle |
getObstacle(Id obstacleId)
Gets the
Obstacle specified by its Id. |
ObstacleList |
getObstacles()
Gets all
Obstacles. |
ObstacleList |
getObstaclesByGenusType(Type obstacleGenusType)
Gets an
ObstacleList corresponding to the given
obstacle genus Type which does not include obstacles of
types derived from the specified Type. |
ObstacleList |
getObstaclesByIds(IdList obstacleIds)
Gets an
ObstacleList corresponding to the given
IdList. |
ObstacleList |
getObstaclesByParentGenusType(Type obstacleGenusType)
Gets an
ObstacleList corresponding to the given
obstacle genus Type and include any additional
obstacles with genus types derived from the specified Type. |
ObstacleList |
getObstaclesByRecordType(Type obstacleRecordType)
Gets an
ObstacleList containing the given obstacle
record Type. |
ObstacleList |
getObstaclesForPath(Id pathId)
Gets an
ObstacleList containing the given path. |
ObstacleList |
getObstaclesForPathAtCoordinate(Id pathId,
Coordinate coordinate,
Distance distance)
Gets an
ObstacleList containing the given path between
the given coordinates inclusive. |
void |
useActiveObstacleView()
Only active obstacles are returned by methods in this session.
|
void |
useAnyStatusObstacleView()
All active and inactive obstacles are returned by methods in this
session.
|
void |
useComparativeObstacleView()
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 |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenaryObstacleView()
A complete view of the
Obstacle returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupObstacles()
Obstacle
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeObstacleView()
mandatory
- This method is must be implemented. void usePlenaryObstacleView()
Obstacle
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. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. void useActiveObstacleView()
mandatory
- This method is must be implemented. void useAnyStatusObstacleView()
mandatory
- This method is must be implemented. Obstacle getObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Obstacle
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Obstacle
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an Obstacle
and retained for compatibility.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.obstacleId
- the Id
of the Obstacle
to retrieve Obstacle
NotFoundException
- no Obstacle
found
with the given Id
NullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesByIds(IdList obstacleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
obstacles specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Obstacles
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.obstacleIds
- the list of Ids
to retrieve Obstacle
listNotFoundException
- an Id was
not foundNullArgumentException
- obstacleIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesByGenusType(Type obstacleGenusType) throws OperationFailedException, PermissionDeniedException
ObstacleList
corresponding to the given
obstacle genus Type
which does not include obstacles of
types derived from the specified Type.
In plenary mode, the returned list contains all known
obstacles or an error obstacles Otherwise, the returned list may
contain only those obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.obstacleGenusType
- an obstacle genus type Obstacle
listNullArgumentException
- obstacleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesByParentGenusType(Type obstacleGenusType) throws OperationFailedException, PermissionDeniedException
ObstacleList
corresponding to the given
obstacle genus Type
and include any additional
obstacles with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
obstacles or an error results. Otherwise, the returned list may
contain only those obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.obstacleGenusType
- an obstacle genus type Obstacle
listNullArgumentException
- obstacleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesByRecordType(Type obstacleRecordType) throws OperationFailedException, PermissionDeniedException
ObstacleList
containing the given obstacle
record Type.
In plenary mode, the returned list contains all known
obstacle or an error results. Otherwise, the returned list may contain
only those obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.obstacleRecordType
- an obstacle record type Obstacle
listNullArgumentException
- obstacleRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ObstacleList
containing the given path.
In plenary mode, the returned list contains all known obstacles or an
error results. Otherwise, the returned list may contain only those
obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.pathId
- a path Id
Obstacle
listNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesForPathAtCoordinate(Id pathId, Coordinate coordinate, Distance distance) throws OperationFailedException, PermissionDeniedException
ObstacleList
containing the given path between
the given coordinates inclusive.
In plenary mode, the returned list contains all known obstacles or an
error results. Otherwise, the returned list may contain only those
obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned.pathId
- a path Id
coordinate
- starting coordinatedistance
- a distance from coordinate Obstacle
listNullArgumentException
- pathId, coordinate
or distance
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstacles() throws OperationFailedException, PermissionDeniedException
Obstacles.
In plenary mode, the returned list contains all known obstacles or an
error results. Otherwise, the returned list may contain only those
obstacles that are accessible through this session.
In active mode, obstacles are returned that are currently active. In
any status mode, active and inactive obstacles are returned. Obstacles
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.