public interface MyLocationSession extends OsidSession
This session defines methods to route between locations.
Modifier and Type | Method and Description |
---|---|
boolean |
atDesignatedLocation()
Tests if this agent is at a designated location.
|
boolean |
canAccessMyLocation()
Tests if this user can query own location.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
Coordinate |
getMyCoordinate()
Gets the current coordinate of this agent.
|
Location |
getMyLocation()
Gets the current location of this agent.
|
LocationList |
getNearestLocationsToMe()
Gets the current nearest locations to this agent ordered by distance.
|
LocationList |
getNearestLocationToMeByGenusType(Type locationGenusType)
Gets the current nearest location of this agent of the specified
location genus type ordered by distance.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAccessMyLocation()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer location operations to unauthorized
users. false
if location methods are not authorized,
true
otherwisemandatory
- This method must be implemented. boolean atDesignatedLocation()
true
if the agent is at a designated location,
false
otherrwisemandatory
- This method must be implemented. Location getMyLocation() throws OperationFailedException, PermissionDeniedException
IllegalStateException
- atDesignatedLocation()
is false
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. Coordinate getMyCoordinate() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LocationList getNearestLocationsToMe() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LocationList getNearestLocationToMeByGenusType(Type locationGenusType) throws OperationFailedException, PermissionDeniedException
locationGenusType
- a location genus typeNullArgumentException
- locationGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.