org.osid.mapping.path

Interface ResourceVelocityUpdateSession

All Superinterfaces:

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

public interface ResourceVelocityUpdateSession
extends OsidSession

This session defines methods to update resource velocities.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUpdateResourceVelocities() Tests if this user can set the velocities of resources.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
void	updateResourceCoordinate(Id resourceId, Coordinate coordinate) Updates the coordinate of the resource.
void	updateResourceVelocity(Id resourceId, Speed speed, Heading heading) Updates the velocity of the resource.

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.

canUpdateResourceVelocities

boolean canUpdateResourceVelocities()

Tests if this user can set the velocities of resources. 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.

Returns:

false if update methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

updateResourceVelocity

void updateResourceVelocity(Id resourceId,
                          Speed speed,
                          Heading heading)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Updates the velocity of the resource.

Parameters:

resourceId - a resource Id

speed - a speed

heading - a heading expressed as a target coordinate

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId, speed or heading is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateResourceCoordinate

void updateResourceCoordinate(Id resourceId,
                            Coordinate coordinate)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Updates the coordinate of the resource.

Parameters:

resourceId - a resource Id

coordinate - a coordinate

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId or coordinate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - coordinate not supported

Compliance:

mandatory - This method must be implemented.