org.osid.locale

Interface CoordinateConversionSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CoordinateConversionSession
extends OsidSession

This session defines methods to convert coordinates across coordinate systems.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSourceCoordinateType

Type getSourceCoordinateType()

Gets the source coordinate type used in this session.

Returns:

the source coordinate type

Compliance:

mandatory - This method must be implemented.

getTargetCoordinateType

Type getTargetCoordinateType()

Gets the target coordinate type used in this session.

Returns:

the target coordinate type

Compliance:

mandatory - This method must be implemented.

canConvertCoordinates

boolean canConvertCoordinates()

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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if conversion methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

convertCoordinate

Coordinate convertCoordinate(Coordinate sourceCoordinate)
                             throws OperationFailedException,
                                    PermissionDeniedException

Converts a coordinate.

Parameters:

sourceCoordinate - the coordinate to convert

Returns:

the resulting coordinate

Throws:

InvalidArgumentException - sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false

NullArgumentException - sourceCoordinate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

convertCoordinates

CoordinateList convertCoordinates(CoordinateList sourceCoordinateList)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Converts coordinates.

Parameters:

sourceCoordinateList - the coordinates to convert

Returns:

the resulting coordinates

Throws:

InvalidArgumentException - sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false

NullArgumentException - sourceCoordinateList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.