public interface CoordinateFormattingSession extends OsidSession
This session defines methods to format and parse coordinates.
Modifier and Type | Method and Description |
---|---|
boolean |
canFormatCoordinates()
Tests if this user can format and parse coordinates.
|
java.lang.String[] |
ccoordinatesToStrings(CoordinateList coordinates)
Gets a string representation of a list of coordinates.
|
java.lang.String |
coordinateToString(Coordinate coordinate)
Gets a string representation of a coordinate.
|
Type |
getCoordinateFormatType()
Gets the coordinate format type used in this session.
|
Type |
getCoordinateType()
Gets the coordinate type used in this session.
|
Coordinate |
stringToCoordinate(java.lang.String s)
Parses a coordinate.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Type getCoordinateType()
mandatory
- This method must be implemented. Type getCoordinateFormatType()
mandatory
- This method must be implemented. boolean canFormatCoordinates()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if translation methods are not
authorized, true
otherwisemandatory
- This method must be implemented. java.lang.String coordinateToString(Coordinate coordinate) throws OperationFailedException, PermissionDeniedException
coordinate
- a coordinate valueInvalidArgumentException
-
coodrinate.hasRecordType(getCoordinateRecordType()
)
is false
NullArgumentException
- coordinate
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. java.lang.String[] ccoordinatesToStrings(CoordinateList coordinates) throws OperationFailedException, PermissionDeniedException
coordinates
- a list of coordinatesInvalidArgumentException
-
coodrinate.hasRecordType(getCoordinateRecordType()
)
is false
NullArgumentException
- coordinates
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. Coordinate stringToCoordinate(java.lang.String s) throws OperationFailedException, PermissionDeniedException
s
- a coordinate stringInvalidArgumentException
- s
is not of
getCoordinateFormatType()
NullArgumentException
- s
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.