org.osid.mapping.path

Interface MyPathSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface MyPathSession
extends OsidSession

This session defines methods to get path information for the authenticated agent.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessMyPath

boolean canAccessMyPath()

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.

Returns:

false if path methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

onDesignatedPath

boolean onDesignatedPath()

Tests if this agent is on a designated path.

Returns:

true if the agent is on a designated path, false otherrwise

Compliance:

mandatory - This method must be implemented.

getMyPath

Path getMyPath()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the current path of this agent.

Returns:

the current path

Throws:

IllegalStateException - onDesignatedPath() is false

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyVelocity

ResourceVelocity getMyVelocity()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the current velocity of this agent.

Returns:

the current velocity

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.