org.jdtaus.banking.dtaus.spi

Interface HeaderValidator

public interface HeaderValidator

Validates Header instances.

jDTAUS Banking SPI HeaderValidator specification to be used by implementations to validate Header instances to hold valid values.

Version:

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

Author:

Christian Schulte

Method Summary

Methods

Modifier and Type	Method and Description
IllegalHeaderException	assertValidHeader(Header header, IllegalHeaderException result) Checks a given Header instance to hold valid values for creating a new LogicalFile.
IllegalHeaderException	assertValidHeader(LogicalFile lFile, Header header, CurrencyCounter counter, IllegalHeaderException result) Checks a given Header instance to hold valid values for updating a given LogicalFile with.

Method Detail

assertValidHeader

IllegalHeaderException assertValidHeader(Header header,
                                       IllegalHeaderException result)

Checks a given Header instance to hold valid values for creating a new LogicalFile.

Parameters:

header - The instance to check.

result - The validation result to be used or null.

Returns:

The validation result passed in as result (maybe null if the implementation did not detect illegal values).

Throws:

NullPointerException - if header is null.

assertValidHeader

IllegalHeaderException assertValidHeader(LogicalFile lFile,
                                       Header header,
                                       CurrencyCounter counter,
                                       IllegalHeaderException result)
                                         throws IOException

Checks a given Header instance to hold valid values for updating a given LogicalFile with.

Parameters:

lFile - The logical file to update with header.

header - The instance to check.

counter - A currency counter reflecting the state of lFile.

result - The validation result to be used or null.

Returns:

The validation result passed in as result (maybe null if the implementation did not detect illegal values).

Throws:

NullPointerException - if either lFile, header or counter is null.

IOException - if reading fails.