Interface MyRouteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MyRouteSession
extends OsidSession

This session defines methods to route between locations.

Method Summary

Modifier and Type	Method	Description
boolean	canAccessMyLocation()	Tests if this user can query own location.
void	cancelMyRoute()	Cancels the current route for this agent.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
RouteProgress	getMyProgress()	Gets the current route progress.
Route	getMyRoute()	Gets the current route of this agent.
RouteSegment	getMyRouteSegment()	Gets the current route segment of this agent.
boolean	isOnRoute()	Tests if this agent is on a route.
RouteSegment	selectMyRoute(Id routeId)	Sets the route for this agent.

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

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.

canAccessMyLocation

boolean canAccessMyLocation()

Tests if this user can query own location. 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 location operations to unauthorized users.

Returns:

false if location methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

isOnRoute

boolean isOnRoute()

Tests if this agent is on a route.

Returns:

true if the agent is on a route, false otherrwise

Compliance:

mandatory - This method must be implemented.

getMyRoute

Route getMyRoute()
          throws OperationFailedException,
PermissionDeniedException

Gets the current route of this agent.

Returns:

the current route

Throws:

IllegalStateException - isOnRoute() is false

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyRouteSegment

RouteSegment getMyRouteSegment()
                        throws OperationFailedException,
PermissionDeniedException

Gets the current route segment of this agent.

Returns:

the current route segment

Throws:

IllegalStateException - isOnRoute() is false

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

selectMyRoute

RouteSegment selectMyRoute(Id routeId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Sets the route for this agent.

Parameters:

routeId - a route Id

Returns:

the current route segment

Throws:

AlreadyExistsException - the agent is already moving on a route

NotFoundException - routeId is not found

NullArgumentException - routeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

cancelMyRoute

void cancelMyRoute()
            throws OperationFailedException,
PermissionDeniedException

Cancels the current route for this agent.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyProgress

RouteProgress getMyProgress()
                     throws OperationFailedException,
PermissionDeniedException

Gets the current route progress.

Returns:

the current route progress

Throws:

IllegalStateException - isOnRoute() is false

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.