org.jdtaus.banking.ri.blzdirectory

Interface BankfileProvider

All Known Implementing Classes:

AbstractPropertiesBankfileProvider, DefaultBankfileProvider

public interface BankfileProvider

Bankfile provider interface.

Version:

$JDTAUS: BankfileProvider.java 8861 2014-01-10 17:09:50Z schulte $

Author:

Christian Schulte

See Also:

BankfileBankleitzahlenVerzeichnis

Method Summary

Methods

Modifier and Type	Method and Description
URL	getBankfile(int index) Gets a bankfile resource.
int	getBankfileCount() Gets the number of provided bankfile resources.
Date	getDateOfExpiration(int index) Gets the date of expiration of a bankfile resource.
Date	getDateOfValidity(int index) Gets the date of validity of a bankfile resource.
int	getFormat(int index) Gets the format of the bankfile resource.
long	getLastModifiedMillis() Gets the timestamp this provider was last modified.

Method Detail

getBankfile

URL getBankfile(int index)
                throws IOException

Gets a bankfile resource.

Parameters:

index - The index of the bankfile resource to get.

Returns:

The bankfile resource at index.

Throws:

IndexOutOfBoundsException - if index is negative or greater or equal to the value returned by method getBankfileCount().

IOException - if getting the bankfile resource fails.

getBankfileCount

int getBankfileCount()
                     throws IOException

Gets the number of provided bankfile resources.

Returns:

The number of provided bankfile resources.

Throws:

IOException - if getting the number of provided bankfile resources fails.

getDateOfExpiration

Date getDateOfExpiration(int index)
                         throws IOException

Gets the date of expiration of a bankfile resource.

Parameters:

index - The index of the bankfile resource to get the date of expiration of.

Returns:

The date of expiration of the bankfile resource index.

Throws:

IndexOutOfBoundsException - if index is negative or greater or equal to the value returned by method getBankfileCount().

IOException - if getting the date of expiration fails.

getDateOfValidity

Date getDateOfValidity(int index)
                       throws IOException

Gets the date of validity of a bankfile resource.

Parameters:

index - The index of the bankfile resource to get the date of validity of.

Returns:

The date of validity of the bankfile resource index.

Throws:

IndexOutOfBoundsException - if index is negative or greater or equal to the value returned by method getBankfileCount().

IOException - if getting the date of validity fails.

getFormat

int getFormat(int index)
              throws IOException

Gets the format of the bankfile resource.

Parameters:

index - The index of the bankfile resource to get the format of.

Returns:

The format of the bankfile resource.

Throws:

IOException - if getting the format of the bankfile resource fails.

Since:

1.15

See Also:

BankleitzahlenDatei.JUNE_2006_FORMAT, BankleitzahlenDatei.JUNE_2013_FORMAT

getLastModifiedMillis

long getLastModifiedMillis()
                           throws IOException

Gets the timestamp this provider was last modified.

Returns:

The timestamp this provider was last modified.

Throws:

IOException - if getting the last modification timestamp fails.