OSID - osid.mapping.MyLocationSession Service Interface Definition

Interface	osid.mapping.MyLocationSession
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	atDesignatedLocation
Description	Tests if this agent is at a designated location.
Return	`boolean`		`true` if the agent is at a designated location, `false` otherrwise
Compliance	`mandatory`		This method must be implemented.
Method	getMyLocation
Description	Gets the current location of this agent.
Return	`osid.mapping.Location`		the current location
Errors	ILLEGAL_STATE		`atDesignatedLocation()` is `false`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMyCoordinate
Description	Gets the current coordinate of this agent.
Return	`osid.mapping.Coordinate`		the current coordinate
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getNearestLocationsToMe
Description	Gets the current nearest locations to this agent ordered by distance.
Return	`osid.mapping.LocationList`		the nearest locations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getNearestLocationToMeByGenusType
Description	Gets the current nearest location of this agent of the specified location genus type ordered by distance.
Parameters	`osid.type.Type`	`locationGenusType`	a location genus type
Return	`osid.mapping.LocationList`		the nearest locations
Errors	NULL_ARGUMENT		`locationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.