public interface MyPathSession extends OsidSession
This session defines methods to get path information for the authenticated agent.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessMyPath()
Tests if this user can query own path.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
Path |
getMyPath()
Gets the current path of this agent.
|
ResourceVelocity |
getMyVelocity()
Gets the current velocity of this agent.
|
boolean |
onDesignatedPath()
Tests if this agent is on a designated path.
|
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 canAccessMyPath()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer path operations to unauthorized users. false
if path methods are not authorized,
true
otherwisemandatory
- This method must be implemented. boolean onDesignatedPath()
true
if the agent is on a designated path,
false
otherrwisemandatory
- This method must be implemented. Path getMyPath() throws OperationFailedException, PermissionDeniedException
IllegalStateException
- onDesignatedPath()
is false
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceVelocity getMyVelocity() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.