Interface | osid.locale.CoordinateFormattingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to format and parse coordinates. | ||
Method | getCoordinateType | ||
Description |
Gets the coordinate type used in this session. | ||
Return | osid.type.Type | the coordinate type | |
Compliance | mandatory | This method must be implemented. | |
Method | getCoordinateFormatType | ||
Description |
Gets the coordinate format type used in this session. | ||
Return | osid.type.Type | the coordinate format type | |
Compliance | mandatory | This method must be implemented. | |
Method | canFormatCoordinates | ||
Description |
Tests if this user can format and parse coordinates. 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 translation methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | coordinateToString | ||
Description |
Gets a string representation of a coordinate. | ||
Parameters | osid.mapping.Coordinate | coordinate | a coordinate value |
Return | string | the display string | |
Errors | INVALID_ARGUMENT | coodrinate.hasRecordType(getCoordinateRecordType() ) is
false | |
NULL_ARGUMENT | coordinate is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | ccoordinatesToStrings | ||
Description |
Gets a string representation of a list of coordinates. | ||
Parameters | osid.mapping.CoordinateList | coordinates | a list of coordinates |
Return | string[] | the display strings | |
Errors | INVALID_ARGUMENT | coodrinate.hasRecordType(getCoordinateRecordType() ) is
false | |
NULL_ARGUMENT | coordinates is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | stringToCoordinate | ||
Description |
Parses a coordinate. | ||
Parameters | string | s | a coordinate string |
Return | osid.mapping.Coordinate | the display string | |
Errors | INVALID_ARGUMENT | s is not of getCoordinateFormatType() | |
NULL_ARGUMENT | s is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |