Interface CurrencyConversionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CurrencyConversionSession
extends OsidSession

This session defines methods to convert currency.

Method Summary

Modifier and Type	Method	Description
boolean	canConvertCurrency()	Tests if this user can perform currency conversions.
Currency[]	convertCurrencies(Currency[] sourceCurrencyAmounts)	Converts currencies.
Currency	convertCurrency(Currency sourceCurrencyAmount)	Converts currency.
Type	getSourceCurrencyType()	Gets the source currency type used in this session.
Type	getTargetCurrencyType()	Gets the target currency type used in this session.

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

getSourceCurrencyType

Type getSourceCurrencyType()

Gets the source currency type used in this session.

Returns:

the source currency

Compliance:

mandatory - This method must be implemented.

getTargetCurrencyType

Type getTargetCurrencyType()

Gets the target currency type used in this session.

Returns:

the target currency

Compliance:

mandatory - This method must be implemented.

canConvertCurrency

boolean canConvertCurrency()

Tests if this user can perform currency 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.

Returns:

false if conversion methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

convertCurrency

Currency convertCurrency(Currency sourceCurrencyAmount)
                  throws OperationFailedException,
PermissionDeniedException

Converts currency.

Parameters:

sourceCurrencyAmount - the currency amount to convert

Returns:

resulting currency units

Throws:

InvalidArgumentException - sourceCurrencyAmount.getCurrencyType() != getSourcecurrencyType()

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

convertCurrencies

Currency[] convertCurrencies(Currency[] sourceCurrencyAmounts)
                      throws OperationFailedException,
PermissionDeniedException

Converts currencies.

Parameters:

sourceCurrencyAmounts - the currency amounts to convert

Returns:

resulting currency units

Throws:

InvalidArgumentException - sourceCurrencyAmount.getCurrencyType() != getSourcecurrencyType()

NullArgumentException - sourceCurrencyAmounts is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.