org.jdtaus.banking.dtaus

Interface PhysicalFile

public interface PhysicalFile

Physical DTAUS file (Inlandszahlungsverkehr).

Version:

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

Author:

Christian Schulte

Method Summary

Methods

Modifier and Type	Method and Description
LogicalFile	addLogicalFile(Header header) Adds a logical file to the physical file.
void	commit() Commits any pending changes.
LogicalFile	getLogicalFile(int index) Gets a logical file for an index.
int	getLogicalFileCount() Gets the number of logical files stored in the physical file.
void	removeLogicalFile(int index) Removes a logical file from the physical file.

Method Detail

addLogicalFile

LogicalFile addLogicalFile(Header header)
                           throws IOException

Adds a logical file to the physical file.

Parameters:

header - The A record of the new logical file.

Returns:

The added logical file.

Throws:

NullPointerException - if header is null.

IllegalHeaderException - if header holds illegal values.

IOException - if reading or writing fails.

commit

void commit()
            throws IOException

Commits any pending changes.

Note:
This method should be called once after finishing work with an instance. Implementations may close any open files when calling this method so that no more operations will be possible after the method returns. Therefore state of an instance is undefined after calling this method. Also note that not calling this method may lead to leaking open file descriptors in the system.

Throws:

IOException - if reading or writing fails.

getLogicalFile

LogicalFile getLogicalFile(int index)
                           throws IOException

Gets a logical file for an index.

Parameters:

index - The index of the logical file to return.

Returns:

The logical file at index.

Throws:

IndexOutOfBoundsException - if index is either negative, or greater or equal to count().

IOException - if reading fails.

getLogicalFileCount

int getLogicalFileCount()
                        throws IOException

Gets the number of logical files stored in the physical file.

Returns:

Number of logical files stored in the physical file.

Throws:

IOException - if reading fails.

removeLogicalFile

void removeLogicalFile(int index)
                       throws IOException

Removes a logical file from the physical file.

Parameters:

index - The index of the logical file to remove.

Throws:

IndexOutOfBoundsException - if index is either negative, or greater or equal to count().

IOException - if reading or writing fails.