org.jdtaus.banking.CurrencyDirectory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdtaus-banking-api Show documentation

jDTAUS banking application programming interface.

There is a newer version: 1.16

/*
 *  jDTAUS Banking API
 *  Copyright (C) 2005 Christian Schulte
 *  
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
package org.jdtaus.banking;

import java.util.Currency;
import java.util.Date;

/**
 * Directory holding currency information.
 * Example: Getting the jDTAUS Banking SPI implementation.
 * CurrencyDirectory directory =
 *     (CurrencyDirectory) ContainerFactory.getContainer().
 *     getObject( CurrencyDirectory.class );
 * 

 *
 * @author Christian Schulte
 * @version $JDTAUS: CurrencyDirectory.java 8661 2012-09-27 11:29:58Z schulte $
 *
 * @see org.jdtaus.core.container.Container
 */
public interface CurrencyDirectory
{

    /**
     * Gets all DTAUS currencies known to the directory for a given date.
     *
     * @param date The date to return known currencies for.
     *
     * @return All DTAUS currencies known to the directory at {@code date} or an empty array if the directory does not
     * hold currencies at {@code date}.
     *
     * @throws NullPointerException if {@code date} is {@code null}.
     */
    Currency[] getDtausCurrencies( Date date );

}