public interface RouteQuerySession extends OsidSession
This session provides methods for searching among Route
objects. The search query is constructed using the RouteQuery.
This session defines views that offer differing behaviors for searching.
Routes may have a query record indicated by their respective record
types. The query record is accessed via the RouteQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRoutes()
Tests if this user can perform
Route lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
RouteQuery |
getRouteQuery()
Gets a route query.
|
RouteList |
getRoutesByQuery(RouteQuery routeQuery)
Gets a list of
Routes matching the given 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 canSearchRoutes()
Route
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. RouteQuery getRouteQuery()
mandatory
- This method must be implemented. RouteList getRoutesByQuery(RouteQuery routeQuery) throws OperationFailedException, PermissionDeniedException
Routes
matching the given search.routeQuery
- the route query RouteList
NullArgumentException
- routeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- routeQuery
is not
of this servicemandatory
- This method must be implemented.