com.neurosys.ecom.strategy.service

Interface CurrencyStrategy

public interface CurrencyStrategy

A common set of API for any project that wishes to attempt automatic conversion of currencies

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
Amount	convert(Amount amt, String toCurrency) Convert an Amount from one currency to another
<O extends Order> O	convert(O order, String toCurrency) Convert an Order from one currency to another.
<U extends User,CONTEXT> String	getDefaultToCurrency(U user, CONTEXT context) During the conversion process, if the application wants to imply a default without any context to the final currrency all amounts will be converted to.
Double	getRate(String fromCurrency, String toCurrency) Provide the rate defined by double value.
<U extends User,CONTEXT> boolean	isSupported(String currency, U user, CONTEXT context) Check if the currency specified is supported by the application for the given CONTEXT (or null).

Method Detail

getDefaultToCurrency

<U extends User,CONTEXT> String getDefaultToCurrency(U user,
                                                     CONTEXT context)

During the conversion process, if the application wants to imply a default without any context to the final currrency all amounts will be converted to.

Parameters:

user - as User (optional)

CONTEXT - (optional)

Returns:

String, can be null if there is no default

isSupported

<U extends User,CONTEXT> boolean isSupported(String currency,
                                             U user,
                                             CONTEXT context)

Check if the currency specified is supported by the application for the given CONTEXT (or null).

Parameters:

currency - as string

user - as User (optional)

CONTEXT - , as an additional context param. @nullable true

Returns:

boolean

getRate

Double getRate(String fromCurrency,
               String toCurrency)

Provide the rate defined by double value. if no conversion exists one can opt to return null.

Parameters:

fromCurrency - as String

toCurrency - as String

Returns:

Double, nullable is true

convert

Amount convert(Amount amt,
               String toCurrency)

Convert an Amount from one currency to another

Parameters:

amt - as actual Amount

toCurrency - as String, to the currency to convert to.

Returns:

Amount. if the input and toCurrency is same it is preferred the same Amount object be returned.

convert

<O extends Order> O convert(O order,
                            String toCurrency)

Convert an Order from one currency to another.

Parameters:

order - as Order

toCurrency - as String, to the currency to convert to.

Returns:

See Also:

ConvertedCurrencyOrder