OSID - osid.mapping.path.MyPathSession Service Interface Definition

Interface	osid.mapping.path.MyPathSession
Implements	`osid.OsidSession`
Description	This session defines methods to get path information for the authenticated agent.
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	canAccessMyPath
Description	Tests if this user can query own path. 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 path operations to unauthorized users.
Return	`boolean`	`false` if path methods are not authorized, `true` otherwise
Compliance	`mandatory`	This method must be implemented.
Method	onDesignatedPath
Description	Tests if this agent is on a designated path.
Return	`boolean`	`true` if the agent is on a designated path, `false` otherrwise
Compliance	`mandatory`	This method must be implemented.
Method	getMyPath
Description	Gets the current path of this agent.
Return	`osid.mapping.path.Path`	the current path
Errors	ILLEGAL_STATE	`onDesignatedPath()` is `false`
	OPERATION_FAILED	unable to complete request
	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.
Method	getMyVelocity
Description	Gets the current velocity of this agent.
Return	`osid.mapping.path.ResourceVelocity`	the current velocity
Errors	OPERATION_FAILED	unable to complete request
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.