org.osid.locale

Interface NumericFormattingSession

All Superinterfaces:

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

public interface NumericFormattingSession
extends OsidSession

This session defines methods to format and parse numbers.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canFormatNumbers() Tests if this user can format and parse numbers.
java.lang.String[]	cardinalsToStrings(long[] c) Gets a string representation of an array of cardinals.
java.lang.String	cardinalToString(long c) Gets a string representation of a cardinal.
java.lang.String[]	decimalsToStrings(java.math.BigDecimal[] d) Gets a string representation of an array of decimals.
java.lang.String	decimalToString(java.math.BigDecimal d) Gets a string representation of a decimal.
java.math.BigDecimal	decimalToString(java.lang.String str) Parses a decimal string.
Type	getNumericFormatType() Gets the numeric format type used in this session.
java.lang.String[]	integersToStrings(long[] i) Gets a string representation of an array of integers.
java.lang.String	integerToString(long i) Gets a string representation of a integer.
long	integerToString(java.lang.String str) Parses an integer string.
long	stringToCardinal(java.lang.String str) Parses a cardinal string.

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

getNumericFormatType

Type getNumericFormatType()

Gets the numeric format type used in this session. The numeric format type indicates the format of a number used in a culture, such as the use of a period for a decimal place.

Returns:

the target language

Compliance:

mandatory - This method must be implemented.

canFormatNumbers

boolean canFormatNumbers()

Tests if this user can format and parse numbers. 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.

cardinalToString

java.lang.String cardinalToString(long c)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets a string representation of a cardinal.

Parameters:

c - a cardinal value

Returns:

the display string

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

cardinalsToStrings

java.lang.String[] cardinalsToStrings(long[] c)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a string representation of an array of cardinals.

Parameters:

c - a cardinal value array

Returns:

the display strings

Throws:

NullArgumentException - c is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

stringToCardinal

long stringToCardinal(java.lang.String str)
                      throws OperationFailedException,
                             PermissionDeniedException

Parses a cardinal string.

Parameters:

str - a cardinal string

Returns:

the cardinal value

Throws:

InvalidArgumentException - str not of getNumericFormatType()

NullArgumentException - str is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

decimalToString

java.lang.String decimalToString(java.math.BigDecimal d)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a string representation of a decimal.

Parameters:

d - a decimal value

Returns:

the display string

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

decimalsToStrings

java.lang.String[] decimalsToStrings(java.math.BigDecimal[] d)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a string representation of an array of decimals.

Parameters:

d - a decimals value array

Returns:

the display strings

Throws:

NullArgumentException - d is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

decimalToString

java.math.BigDecimal decimalToString(java.lang.String str)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Parses a decimal string.

Parameters:

str - a decimal string

Returns:

the decimal value

Throws:

InvalidArgumentException - str not of getNumericFormatType()

NullArgumentException - str is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

integerToString

java.lang.String integerToString(long i)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a string representation of a integer.

Parameters:

i - an integer value

Returns:

the display string

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

integersToStrings

java.lang.String[] integersToStrings(long[] i)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a string representation of an array of integers.

Parameters:

i - an integer value array

Returns:

the display strings

Throws:

NullArgumentException - i is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

integerToString

long integerToString(java.lang.String str)
                     throws OperationFailedException,
                            PermissionDeniedException

Parses an integer string.

Parameters:

str - an integer string

Returns:

the integer value

Throws:

InvalidArgumentException - str not of getNumericFormatType()

NullArgumentException - str is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.