OSID Logo
OSID Specifications
locale package
Version 3.0.0
Release Candidate Preview
Interfaceosid.locale.CoordinateConversionSession
Implementsosid.OsidSession
Description

This session defines methods to convert coordinates across coordinate systems.

MethodgetSourceCoordinateType
Description

Gets the source coordinate type used in this session.

Returnosid.type.Typethe source coordinate type
CompliancemandatoryThis method must be implemented.
MethodgetTargetCoordinateType
Description

Gets the target coordinate type used in this session.

Returnosid.type.Typethe target coordinate type
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodconvertCoordinate
Description

Converts a coordinate.

Parametersosid.mapping.CoordinatesourceCoordinatethe coordinate to convert
Returnosid.mapping.Coordinatethe resulting coordinate
ErrorsINVALID_ARGUMENT sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false
NULL_ARGUMENT sourceCoordinate is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodconvertCoordinates
Description

Converts coordinates.

Parametersosid.mapping.CoordinateListsourceCoordinateListthe coordinates to convert
Returnosid.mapping.CoordinateListthe resulting coordinates
ErrorsINVALID_ARGUMENT sourceCoordinate.hasType(getSourceCoordinateRecordType()) is false
NULL_ARGUMENT sourceCoordinateList is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.