Interface MyPathSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MyPathSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.