public interface RouteSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RouteQuery
can be retrieved from this session
and mapped to this Map
to create a virtual collection of
Routes.
The routes may be sequenced using the
RouteSearchOrder
from this session.
This Map
has a default query that matches any route and
a default search order that specifies no sequencing. The queries may be
examined using a RouteQueryInspector.
The query may be
modified by converting the inspector back to a RouteQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRouteQuery(RouteQuery routeQuery)
Applies a route query to this map.
|
void |
applyRouteSequencing(RouteSearchOrder routeSearchOrder)
Applies a route search order to this map.
|
boolean |
canManageSmartMaps()
Tests if this user can manage smart maps.
|
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.
|
RouteQuery |
getRouteQueryFromInspector(RouteQueryInspector routeQueryInspector)
Gets a route query from an inspector.
|
RouteSearchOrder |
getRouteSearchOrder()
Gets a route search order.
|
RouteQueryInspector |
inspectRouteQuery()
Gets a route query inspector for this map.
|
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 canManageSmartMaps()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart map management is not
authorized, true
otherwisemandatory
- This method must be implemented. RouteQuery getRouteQuery()
mandatory
- This method must be implemented. RouteSearchOrder getRouteSearchOrder()
mandatory
- This method must be implemented. void applyRouteQuery(RouteQuery routeQuery) throws OperationFailedException, PermissionDeniedException
routeQuery
- the route queryNullArgumentException
- routeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- routeQuery
not of
this servicemandatory
- This method must be implemented. RouteQueryInspector inspectRouteQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRouteSequencing(RouteSearchOrder routeSearchOrder) throws OperationFailedException, PermissionDeniedException
routeSearchOrder
- the route search orderNullArgumentException
- routeSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- routeSearchOrder
not of this servicemandatory
- This method must be implemented. RouteQuery getRouteQueryFromInspector(RouteQueryInspector routeQueryInspector)
routeQueryInspector
- a route query inspectorNullArgumentException
- routeQueryInspector
is null
UnsupportedException
- routeQueryInspector
is not of this servicemandatory
- This method must be implemented.