Interface RouteMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RouteMapSession
extends OsidSession

This session provides methods to retrieve Route to Map mappings. A Route may appear in multiple Maps . Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupRouteMapLocations()	Tests if this user can perform lookups of route/map mappings.
IdList	getMapIdsByRoute(Id routeId)	Gets the Map Ids mapped to a Route .
MapList	getMapsByRoute(Id routeId)	Gets the Maps mapped to a Route .
IdList	getRouteIdsByMap(Id mapId)	Gets the list of Route Ids associated with a Map .
IdList	getRouteIdsByMaps(IdList mapIds)	Gets the list of Route Ids corresponding to a list of Maps .
RouteList	getRoutesByMap(Id mapId)	Gets the list of Routes associated with a Map .
RouteList	getRoutesByMaps(IdList mapIds)	Gets the list of Route corresponding to a list of Maps .
void	useComparativeRouteMapView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryRouteMapView()	A complete view of the Route and Map returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupRouteMapLocations

boolean canLookupRouteMapLocations()

Tests if this user can perform lookups of route/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRouteMapView

void useComparativeRouteMapView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRouteMapView

void usePlenaryRouteMapView()

A complete view of the Route and Map returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRouteIdsByMap

IdList getRouteIdsByMap(Id mapId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Route Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related route Ids

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRoutesByMap

RouteList getRoutesByMap(Id mapId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Routes associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related routes

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRouteIdsByMaps

IdList getRouteIdsByMaps(IdList mapIds)
                  throws OperationFailedException,
PermissionDeniedException

Gets the list of Route Ids corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of route Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRoutesByMaps

RouteList getRoutesByMaps(IdList mapIds)
                   throws OperationFailedException,
PermissionDeniedException

Gets the list of Route corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of routes

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsByRoute

IdList getMapIdsByRoute(Id routeId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a Route .

Parameters:

routeId - Id of a Route

Returns:

list of maps

Throws:

NotFoundException - routeId is not found

NullArgumentException - routeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsByRoute

MapList getMapsByRoute(Id routeId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a Route .

Parameters:

routeId - Id of a Route

Returns:

list of maps

Throws:

NotFoundException - routeId is not found

NullArgumentException - routeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.