org.jdtaus.banking.dtaus.LogicalFile 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.dtaus;

import java.io.IOException;

/**
 * Logical DTAUS file (Inlandszahlungsverkehr).
 *
 * @author Christian Schulte
 * @version $JDTAUS: LogicalFile.java 8661 2012-09-27 11:29:58Z schulte $
 */
public interface LogicalFile
{

    /**
     * Gets the A record of the logical file.
     *
     * @return The A record of the logical file.
     *
     * @throws IOException if reading fails.
     */
    Header getHeader() throws IOException;

    /**
     * Updates the A record of the logical file.
     *
     * @param header New A record for the logical file.
     *
     * @return The previous A record of the logical file.
     *
     * @throws NullPointerException if {@code header} is {@code null}.
     * @throws IllegalHeaderException if {@code header} holds illegal values.
     * @throws IOException if reading or writing fails.
     */
    Header setHeader( Header header ) throws IOException;

    /**
     * Gets the E record of the logical file.
     *
     * @return The E record of the logical file.
     *
     * @throws IOException if reading fails.
     */
    Checksum getChecksum() throws IOException;

    /**
     * Adds a C record to the logical file.
     *
     * @param transaction The transaction to add to the logical file.
     *
     * @throws IndexOutOfBoundsException if no more transactions can be added to the logical file.
     * @throws NullPointerException if {@code transaction} is {@code null}.
     * @throws IllegalTransactionException if {@code transaction} holds illegal values.
     * @throws IOException if writing fails.
     *
     * @deprecated This method got replaced by {@link #addTransaction(Transaction)} which is capable of returning the
     * index of the transaction in the file.
     */
     void createTransaction( Transaction transaction ) throws IOException;

    /**
     * Adds a C record to the logical file.
     *
     * @param transaction The transaction to add to the logical file.
     *
     * @return The index of the transaction in the logical file.
     *
     * @throws IndexOutOfBoundsException if no more transactions can be added to the logical file.
     * @throws NullPointerException if {@code transaction} is {@code null}.
     * @throws IllegalTransactionException if {@code transaction} holds illegal values.
     * @throws IOException if writing fails.
     */
    int addTransaction( Transaction transaction ) throws IOException;

    /**
     * Gets a C record for an index.
     *
     * @param index The index of the transaction to return.
     *
     * @return The C record at {@code index}.
     *
     * @throws IndexOutOfBoundsException if the logical file holds transactions and {@code index} is either negative or
     * greater or equal to the number of transactions stored in the file.
     * @throws IOException if reading fails.
     */
    Transaction getTransaction( int index ) throws IOException;

    /**
     * Updates a C record at a given index.
     *
     * @param index The index of the transaction to update.
     * @param transaction The transaction to overwrite the transaction at {@code index} with.
     *
     * @return The transaction previously stored at {@code index}.
     *
     * @throws IndexOutOfBoundsException if the logical file holds transactions and {@code index} is either negative or
     * greater or equal to the number of transactions stored in the file.
     * @throws NullPointerException if {@code transaction} is {@code null}.
     * @throws IllegalTransactionException if {@code transaction} holds illegal values.
     * @throws IOException if reading or writing fails.
     */
    Transaction setTransaction( int index, Transaction transaction ) throws IOException;

    /**
     * Removes a C record at a given index.
     *
     * @param index The index of the transaction to remove.
     *
     * @return The removed transaction.
     *
     * @throws IndexOutOfBoundsException if the logical file holds transactions and {@code index} is either negative or
     * greater or equal to the number of transactions stored in the file.
     * @throws IOException if reading or writing fails.
     */
    Transaction removeTransaction( int index ) throws IOException;

}