Interface RouteSmartMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Like all OsidSessions, RouteSmartMapSessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
    throws OperationFailedException,
PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartMaps

boolean canManageSmartMaps()

Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart map management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRouteQuery

RouteQuery getRouteQuery()

Gets a route query.

Returns:

the route query

Compliance:

mandatory - This method must be implemented.

getRouteSearchOrder

RouteSearchOrder getRouteSearchOrder()

Gets a route search order.

Returns:

the route search order

Compliance:

mandatory - This method must be implemented.

applyRouteQuery

void applyRouteQuery(RouteQuery routeQuery)
              throws OperationFailedException,
PermissionDeniedException

Applies a route query to this map.

Parameters:

routeQuery - the route query

Throws:

NullArgumentException - routeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - routeQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRouteQuery

RouteQueryInspector inspectRouteQuery()
                               throws OperationFailedException,
PermissionDeniedException

Gets a route query inspector for this map.

Returns:

the route query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRouteSequencing

void applyRouteSequencing(RouteSearchOrder routeSearchOrder)
                   throws OperationFailedException,
PermissionDeniedException

Applies a route search order to this map.

Parameters:

routeSearchOrder - the route search order

Throws:

NullArgumentException - routeSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - routeSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRouteQueryFromInspector

RouteQuery getRouteQueryFromInspector(RouteQueryInspector routeQueryInspector)

Gets a route query from an inspector.

Parameters:

routeQueryInspector - a route query inspector

Returns:

the route query

Throws:

NullArgumentException - routeQueryInspector is null

UnsupportedException - routeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.