org.osid.mapping.route

Interface MyRouteSession

All Superinterfaces:

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

public interface MyRouteSession
extends OsidSession

This session defines methods to route between locations.

Method Summary

Methods

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

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.