OSID - osid.mapping.route.MyRouteSession Service Interface Definition

Interface	osid.mapping.route.MyRouteSession
Implements	`osid.OsidSession`
Description	This session defines methods to route between locations.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessMyLocation
Description	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.
Return	`boolean`		`false` if location methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isOnRoute
Description	Tests if this agent is on a route.
Return	`boolean`		`true` if the agent is on a route, `false` otherrwise
Compliance	`mandatory`		This method must be implemented.
Method	getMyRoute
Description	Gets the current route of this agent.
Return	`osid.mapping.route.Route`		the current route
Errors	ILLEGAL_STATE		`isOnRoute()` is `false`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMyRouteSegment
Description	Gets the current route segment of this agent.
Return	`osid.mapping.route.RouteSegment`		the current route segment
Errors	ILLEGAL_STATE		`isOnRoute()` is `false`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	selectMyRoute
Description	Sets the route for this agent.
Parameters	`osid.id.Id`	`routeId`	a route `Id`
Return	`osid.mapping.route.RouteSegment`		the current route segment
Errors	ALREADY_EXISTS		the agent is already moving on a route
	NOT_FOUND		`routeId` is not found
	NULL_ARGUMENT		`routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	cancelMyRoute
Description	Cancels the current route for this agent.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMyProgress
Description	Gets the current route progress.
Return	`osid.mapping.route.RouteProgress`		the current route progress
Errors	ILLEGAL_STATE		`isOnRoute()` is `false`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.