public interface CoordinateConversionSession extends OsidSession
This session defines methods to convert coordinates across coordinate systems.
Modifier and Type | Method and Description |
---|---|
boolean |
canConvertCoordinates()
Tests if this user can perform coordinate conversions.
|
Coordinate |
convertCoordinate(Coordinate sourceCoordinate)
Converts a coordinate.
|
CoordinateList |
convertCoordinates(CoordinateList sourceCoordinateList)
Converts coordinates.
|
Type |
getSourceCoordinateType()
Gets the source coordinate type used in this session.
|
Type |
getTargetCoordinateType()
Gets the target coordinate type used in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Type getSourceCoordinateType()
mandatory
- This method must be implemented. Type getTargetCoordinateType()
mandatory
- This method must be implemented. boolean canConvertCoordinates()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if conversion methods are not authorized,
true
otherwisemandatory
- This method must be implemented. Coordinate convertCoordinate(Coordinate sourceCoordinate) throws OperationFailedException, PermissionDeniedException
sourceCoordinate
- the coordinate to convertInvalidArgumentException
-
sourceCoordinate.hasType(getSourceCoordinateRecordType())
is false
NullArgumentException
- sourceCoordinate
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CoordinateList convertCoordinates(CoordinateList sourceCoordinateList) throws OperationFailedException, PermissionDeniedException
sourceCoordinateList
- the coordinates to convertInvalidArgumentException
-
sourceCoordinate.hasType(getSourceCoordinateRecordType())
is false
NullArgumentException
- sourceCoordinateList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.