Interface | osid.locale.CoordinateConversionSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to convert coordinates across coordinate systems. | ||
Method | getSourceCoordinateType | ||
Description |
Gets the source coordinate type used in this session. | ||
Return | osid.type.Type | the source coordinate type | |
Compliance | mandatory | This method must be implemented. | |
Method | getTargetCoordinateType | ||
Description |
Gets the target coordinate type used in this session. | ||
Return | osid.type.Type | the target coordinate type | |
Compliance | mandatory | This method must be implemented. | |
Method | canConvertCoordinates | ||
Description |
Tests if this user can perform coordinate conversions.
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 conversion methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | convertCoordinate | ||
Description |
Converts a coordinate. | ||
Parameters | osid.mapping.Coordinate | sourceCoordinate | the coordinate to convert |
Return | osid.mapping.Coordinate | the resulting coordinate | |
Errors | INVALID_ARGUMENT | sourceCoordinate.hasType(getSourceCoordinateRecordType()) is
false | |
NULL_ARGUMENT | sourceCoordinate is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | convertCoordinates | ||
Description |
Converts coordinates. | ||
Parameters | osid.mapping.CoordinateList | sourceCoordinateList | the coordinates to convert |
Return | osid.mapping.CoordinateList | the resulting coordinates | |
Errors | INVALID_ARGUMENT | sourceCoordinate.hasType(getSourceCoordinateRecordType()) is
false | |
NULL_ARGUMENT | sourceCoordinateList is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |