Interface NumericFormattingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface NumericFormattingSession
extends OsidSession

This session defines methods to format and parse numbers.

Method Summary

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

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

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

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

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(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

String decimalToString(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

String[] decimalsToStrings(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

BigDecimal decimalToString(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

String integerToString(long i)
                throws OperationFailedException,
PermissionDeniedException

Gets a string representation of an 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

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(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.