org.jdtaus.banking

Interface BankleitzahlenVerzeichnis

public interface BankleitzahlenVerzeichnis

Public directory of german bank codes.

For further information see the Merkblatt Bankleitzahlendatei. An updated version of the document may be found at Deutsche Bundesbank.

Example: Getting the jDTAUS Banking SPI implementation.

 BankleitzahlenVerzeichnis directory =
     (BankleitzahlenVerzeichnis) ContainerFactory.getContainer().
     getObject( BankleitzahlenVerzeichnis.class );
 

Version:

$JDTAUS: BankleitzahlenVerzeichnis.java 8725 2012-10-04 21:26:50Z schulte $

Author:

Christian Schulte

See Also:

Container

Method Summary

Methods

Modifier and Type	Method and Description
BankleitzahlInfo[]	getBranchOffices(Bankleitzahl bankCode) Gets the records of the branch offices for a given Bankleitzahl.
Date	getDateOfExpiration() Gets the date of expiration of the data.
BankleitzahlInfo	getHeadOffice(Bankleitzahl bankCode) Gets the record of the head office for a given Bankleitzahl.
BankleitzahlInfo[]	searchBankleitzahlInfos(String name, String postalCode, String city, Boolean headOffices, Boolean branchOffices) Searches the directory for records matching the given criteria.

Method Detail

getBranchOffices

BankleitzahlInfo[] getBranchOffices(Bankleitzahl bankCode)
                                    throws BankleitzahlExpirationException

Gets the records of the branch offices for a given Bankleitzahl.

Parameters:

bankCode - The Bankleitzahl to return the records of corresponding branch offices for.

Returns:

The branch offices of the bank identified by bankCode or an empty array if the directory does not hold corresponding records for bankCode.

Throws:

NullPointerException - if bankCode is null.

BankleitzahlExpirationException - if bankCode has expired.

getDateOfExpiration

Date getDateOfExpiration()

Gets the date of expiration of the data.

Returns:

the date of expiration of the data.

getHeadOffice

BankleitzahlInfo getHeadOffice(Bankleitzahl bankCode)
                               throws BankleitzahlExpirationException

Gets the record of the head office for a given Bankleitzahl.

Parameters:

bankCode - A Bankleitzahl to return the record of the corresponding head office for.

Returns:

The head office of the bank identified by bankCode or null if no head office exists for bankCode.

Throws:

NullPointerException - if bankCode is null.

BankleitzahlExpirationException - if bankCode has expired.

searchBankleitzahlInfos

BankleitzahlInfo[] searchBankleitzahlInfos(String name,
                                         String postalCode,
                                         String city,
                                         Boolean headOffices,
                                         Boolean branchOffices)

Searches the directory for records matching the given criteria.

Parameters:

name - Text to select records whose property name matches the given text; null to ignore property name during searching.

postalCode - Text to select records whose property postalCode matches the given text; null to ignore property postalCode during searching.

city - Text to select records whose property city matches the given text; null to ignore property city during searching.

headOffices - true to return head office records; false to not return head office records; null to ignore property headOffice during searching.

branchOffices - true to return branch office records; false to not return branch office records; null to ignore property headOffice during searching.

Returns:

All records matching the given criteria.

Throws:

IllegalArgumentException - if name, postalCode or city contains data which cannot be used for searching the directory.