org.jdtaus.banking.dtaus

Interface LogicalFile

public interface LogicalFile

Logical DTAUS file (Inlandszahlungsverkehr).

Version:

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

Author:

Christian Schulte

Method Summary

Methods

Modifier and Type	Method and Description
int	addTransaction(Transaction transaction) Adds a C record to the logical file.
Checksum	getChecksum() Gets the E record of the logical file.
Header	getHeader() Gets the A record of the logical file.
Transaction	getTransaction(int index) Gets a C record for an index.
Transaction	removeTransaction(int index) Removes a C record at a given index.
Header	setHeader(Header header) Updates the A record of the logical file.
Transaction	setTransaction(int index, Transaction transaction) Updates a C record at a given index.

Method Detail

addTransaction

int addTransaction(Transaction transaction)
                   throws IOException

Adds a C record to the logical file.

Parameters:

transaction - The transaction to add to the logical file.

Returns:

The index of the transaction in the logical file.

Throws:

IndexOutOfBoundsException - if no more transactions can be added to the logical file.

NullPointerException - if transaction is null.

IllegalTransactionException - if transaction holds illegal values.

IOException - if writing fails.

getChecksum

Checksum getChecksum()
                     throws IOException

Gets the E record of the logical file.

Returns:

The E record of the logical file.

Throws:

IOException - if reading fails.

getHeader

Header getHeader()
                 throws IOException

Gets the A record of the logical file.

Returns:

The A record of the logical file.

Throws:

IOException - if reading fails.

getTransaction

Transaction getTransaction(int index)
                           throws IOException

Gets a C record for an index.

Parameters:

index - The index of the transaction to return.

Returns:

The C record at index.

Throws:

IndexOutOfBoundsException - if the logical file holds transactions and index is either negative or greater or equal to the number of transactions stored in the file.

IOException - if reading fails.

removeTransaction

Transaction removeTransaction(int index)
                              throws IOException

Removes a C record at a given index.

Parameters:

index - The index of the transaction to remove.

Returns:

The removed transaction.

Throws:

IndexOutOfBoundsException - if the logical file holds transactions and index is either negative or greater or equal to the number of transactions stored in the file.

IOException - if reading or writing fails.

setHeader

Header setHeader(Header header)
                 throws IOException

Updates the A record of the logical file.

Parameters:

header - New A record for the logical file.

Returns:

The previous A record of the logical file.

Throws:

NullPointerException - if header is null.

IllegalHeaderException - if header holds illegal values.

IOException - if reading or writing fails.

setTransaction

Transaction setTransaction(int index,
                         Transaction transaction)
                           throws IOException

Updates a C record at a given index.

Parameters:

index - The index of the transaction to update.

transaction - The transaction to overwrite the transaction at index with.

Returns:

The transaction previously stored at index.

Throws:

IndexOutOfBoundsException - if the logical file holds transactions and index is either negative or greater or equal to the number of transactions stored in the file.

NullPointerException - if transaction is null.

IllegalTransactionException - if transaction holds illegal values.

IOException - if reading or writing fails.