Interface CoordinateConversionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CoordinateConversionSession
extends OsidSession

This session defines methods to convert coordinates across coordinate systems.

Method Summary

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.