Interface | osid.mapping.ResourceLocationUpdateSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines update positions of resources. | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateResourceLocations | ||
Description |
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 | ||
Return | boolean | false if location methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | updateResourceLocation | ||
Description |
Updates the location of the resource. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.id.Id | locationId | a location Id | |
Errors | NOT_FOUND | resourceId or locationId is not found | |
NULL_ARGUMENT | resourceId or locationId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateResourceCoordinate | ||
Description |
Updates the coordinate of the resource. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.mapping.Coordinate | coordinate | a coordinate | |
Errors | NOT_FOUND | resourceId is not found | |
NULL_ARGUMENT | resourceId or coordinate is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | coordinate not supported | ||
Compliance | mandatory | This method must be implemented. |