OSID Logo
OSID Specifications
locale package
Version 3.1.0
Interfaceosid.locale.CoordinateConversionSession
Implementsosid.OsidSession
Used Byosid.locale.LocaleManager
osid.locale.LocaleProxyManager
Description

This session defines methods to convert coordinates across coordinate systems.

MethodgetSourceCoordinateType
Description

Gets the source coordinate type used in this session.

Returnosid.type.Type the source coordinate type
Compliancemandatory This method must be implemented.
MethodgetTargetCoordinateType
Description

Gets the target coordinate type used in this session.

Returnosid.type.Type the target coordinate type
Compliancemandatory This method must be implemented.
MethodcanConvertCoordinates
Description

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.

Returnboolean false if conversion methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodconvertCoordinate
Description

Converts a coordinate.

Parametersosid.mapping.CoordinatesourceCoordinate the coordinate to convert
Returnosid.mapping.Coordinate the resulting coordinate
ErrorsINVALID_ARGUMENT sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false
NULL_ARGUMENT sourceCoordinate is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodconvertCoordinates
Description

Converts coordinates.

Parametersosid.mapping.CoordinateListsourceCoordinateList the coordinates to convert
Returnosid.mapping.CoordinateList the resulting coordinates
ErrorsINVALID_ARGUMENT sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false
NULL_ARGUMENT sourceCoordinateList is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.