Interface ResourceLocationUpdateSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ResourceLocationUpdateSession
extends OsidSession

This session defines update positions of resources.

Like all OsidSessions, ResourceLocationUpdateSessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type	Method	Description
boolean	canUpdateResourceLocations()	Tests if this user can set the locations 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	updateResourceLocation(Id resourceId, Id locationId)	Updates the location of the resource.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

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.

canUpdateResourceLocations

boolean canUpdateResourceLocations()

Tests if this user can set the locations 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 location methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

updateResourceLocation

void updateResourceLocation(Id resourceId,
 Id locationId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Updates the location of the resource.

Parameters:

resourceId - a resource Id

locationId - a location Id

Throws:

NotFoundException - resourceId or locationId is not found

NullArgumentException - resourceId or locationId 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.