org.jdtaus.banking.spi

Interface CurrencyMapper

All Superinterfaces:

CurrencyDirectory

public interface CurrencyMapper
extends CurrencyDirectory

Maps Currency instances to various codes.

jDTAUS Banking SPI CurrencyMapper specification to be used by implementations to map Currency instances to codes and vice versa.

Version:

$JDTAUS: CurrencyMapper.java 8661 2012-09-27 11:29:58Z schulte $

Author:

Christian Schulte

See Also:

Container

Method Summary

Methods

Modifier and Type	Method and Description
char	getDtausCode(Currency currency, Date date) Gets the DTAUS code for a currency at a given date.
Currency	getDtausCurrency(char code, Date date) Gets the currency for a DTAUS code at a given date.

Methods inherited from interface org.jdtaus.banking.CurrencyDirectory

getDtausCurrencies

Method Detail

getDtausCode

char getDtausCode(Currency currency,
                Date date)

Gets the DTAUS code for a currency at a given date.

Parameters:

currency - The currency to return the corresponding DTAUS code for.

date - The date to return the DTAUS code for.

Returns:

The DTAUS code for currency at date.

Throws:

NullPointerException - if either currency or date is null.

UnsupportedCurrencyException - if currency is not known to the directory at date.

getDtausCurrency

Currency getDtausCurrency(char code,
                        Date date)

Gets the currency for a DTAUS code at a given date.

Parameters:

code - The DTAUS code to return the corresponding currency for.

date - The date to return the currency for.

Returns:

The currency corresponding to code at date or null if no currency matching code is known to the directory at date.

Throws:

NullPointerException - if date is null.