public interface ObstacleQuerySession extends OsidSession
This session provides methods for searching among Obstacle
objects. The search query is constructed using the
ObstacleQuery.
This session defines views that offer differing behaviors for searching.
Obstacles may have a query record indicated by their respective record
types. The query record is accessed via the ObstacleQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchObstacles()
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. |
ObstacleQuery |
getObstacleQuery()
Gets an obstacle query.
|
ObstacleList |
getObstaclesByQuery(ObstacleQuery obstacleQuery)
Gets a list of
Obstacles matching the given obstacle
search. |
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
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 canSearchObstacles()
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 search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. ObstacleQuery getObstacleQuery()
mandatory
- This method must be implemented. ObstacleList getObstaclesByQuery(ObstacleQuery obstacleQuery) throws OperationFailedException, PermissionDeniedException
Obstacles
matching the given obstacle
search.obstacleQuery
- the obstacle query ObstacleList
NullArgumentException
- obstacleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- obstacleQuery
is
not of this servicemandatory
- This method must be implemented.