org.osid.locale

Interface CoordinateFormattingSession

All Superinterfaces:

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

public interface CoordinateFormattingSession
extends OsidSession

This session defines methods to format and parse coordinates.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canFormatCoordinates() Tests if this user can format and parse coordinates.
java.lang.String[]	ccoordinatesToStrings(CoordinateList coordinates) Gets a string representation of a list of coordinates.
java.lang.String	coordinateToString(Coordinate coordinate) Gets a string representation of a coordinate.
Type	getCoordinateFormatType() Gets the coordinate format type used in this session.
Type	getCoordinateType() Gets the coordinate type used in this session.
Coordinate	stringToCoordinate(java.lang.String s) Parses a coordinate.

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

getCoordinateType

Type getCoordinateType()

Gets the coordinate type used in this session.

Returns:

the coordinate type

Compliance:

mandatory - This method must be implemented.

getCoordinateFormatType

Type getCoordinateFormatType()

Gets the coordinate format type used in this session.

Returns:

the coordinate format type

Compliance:

mandatory - This method must be implemented.

canFormatCoordinates

boolean canFormatCoordinates()

Tests if this user can format and parse coordinates. 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 translation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

coordinateToString

java.lang.String coordinateToString(Coordinate coordinate)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a string representation of a coordinate.

Parameters:

coordinate - a coordinate value

Returns:

the display string

Throws:

InvalidArgumentException - coodrinate.hasRecordType(getCoordinateRecordType() ) is false

NullArgumentException - coordinate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

ccoordinatesToStrings

java.lang.String[] ccoordinatesToStrings(CoordinateList coordinates)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets a string representation of a list of coordinates.

Parameters:

coordinates - a list of coordinates

Returns:

the display strings

Throws:

InvalidArgumentException - coodrinate.hasRecordType(getCoordinateRecordType() ) is false

NullArgumentException - coordinates is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

stringToCoordinate

Coordinate stringToCoordinate(java.lang.String s)
                              throws OperationFailedException,
                                     PermissionDeniedException

Parses a coordinate.

Parameters:

s - a coordinate string

Returns:

the display string

Throws:

InvalidArgumentException - s is not of getCoordinateFormatType()

NullArgumentException - s is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.