org.osid.mapping.route

Interface RouteQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

RouteSearchSession

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.

• federated map view: searches include routes in maps of which this map is an ancestor in the map hierarchy
• isolated map view: searches are restricted to routes in this map

Routes may have a query record indicated by their respective record types. The query record is accessed via the RouteQuery.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canSearchRoutes

boolean canSearchRoutes()

Tests if this user can perform 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.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include routes in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts searches to this map only.

Compliance:

mandatory - This method is must be implemented.

getRouteQuery

RouteQuery getRouteQuery()

Gets a route query.

Returns:

the route query

Compliance:

mandatory - This method must be implemented.

getRoutesByQuery

RouteList getRoutesByQuery(RouteQuery routeQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Routes matching the given search.

Parameters:

routeQuery - the route query

Returns:

the returned RouteList

Throws:

NullArgumentException - routeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - routeQuery is not of this service

Compliance:

mandatory - This method must be implemented.