public interface ResourceLocationUpdateSession extends OsidSession
This session defines update positions of resources.
Modifier and Type | Method and 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.
|
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 canUpdateResourceLocations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer location operations to unauthorized
users. false
if location methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void updateResourceLocation(Id resourceId, Id locationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
locationId
- a location Id
NotFoundException
- resourceId
or
locationId
is not foundNullArgumentException
- resourceId
or
locationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateResourceCoordinate(Id resourceId, Coordinate coordinate) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
coordinate
- a coordinateNotFoundException
- resourceId
is not
foundNullArgumentException
- resourceId
or
coordinate
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- coordinate not supportedmandatory
- This method must be implemented.