#include <bank.h>
Public Methods | |
| Bank () | |
| virtual | ~Bank () |
| virtual const Hbci * | hbci () const=0 |
Bank Identification | |
| virtual int | countryCode () const=0 |
| virtual void | setCountryCode (int i)=0 |
| virtual const string & | bankCode () const=0 |
| virtual void | setBankCode (const string &s)=0 |
Bank Information | |
| virtual const string & | name () const=0 |
| virtual const list< instituteMessage > & | messages () const=0 |
| virtual void | deleteInstituteMessage (const instituteMessage &msg)=0 |
Object retrieval | |
| virtual const list< Pointer< Account > > & | accounts () const=0 |
| virtual const list< Pointer< User > > & | users () const=0 |
| virtual Pointer< User > | findUser (const string &userid) const=0 |
| virtual Pointer< Customer > | findCustomer (const string &id) const=0 |
| virtual Pointer< Account > | findAccount (const string &nr, const string &subid="") const=0 |
Manage Objects | |
| virtual void | addAccount (Pointer< Account > a)=0 |
| virtual void | removeAccount (Pointer< Account > a)=0 |
| virtual void | addUser (Pointer< User > c)=0 |
| virtual void | removeUser (Pointer< User > c)=0 |
Communication Parameters | |
| virtual const string & | addr () const=0 |
| virtual void | setAddr (const string &s)=0 |
| virtual int | type () const=0 |
| virtual void | setType (int i)=0 |
| virtual const string & | suffix () const=0 |
| virtual void | setSuffix (const string &s)=0 |
Dialog Language | |
| virtual int | language () const=0 |
| virtual void | setLanguage (int l)=0 |
| virtual const list< int > & | languages () const=0 |
HBCI Version | |
| virtual int | hbciVersion () const=0 |
| virtual void | setHbciVersion (int v)=0 |
| virtual int | bpdVersion () const=0 |
| virtual void | setBPDVersion (int i)=0 |
| virtual list< int > | supportedVersions () const=0 |
| virtual const bpdJob * | findJob (const string &segname, int minv=0, int maxv=9999) const=0 |
This is the abstract base class for a bank in HBCI. A bank is uniquely identified by its bank code ("BLZ") and country code. For the network connection this bank has a connection address (IP address). The real-world name of the bank is usually retrieved automatically upon our first connection to the bank.
Each bank object maintains a list of its users (which in turn have a list of customers) as well as a list of its accounts. There is also a list of institute messages which this bank has sent to us. Additionally, the bank might support several HBCI versions and/or dialog languages.
You can't create an object of this class directly; instead, use the factory method provided by API::bankFactory. Internally another class is used as implementation of this abstract class.
|
|
|
|
|
|
|
|
Returns the list of accounts at this bank.
|
|
|
Add an account to the account list of this bank. Ideally, you wouldn't need this as the bank is supposed to send you a list of all accounts valid for your user ID. However, some banks simply don't do that, so that's why this method is here. If there already is an entry for the same account a Error will be thrown.
|
|
|
Returns the communication address. Depends on type of protocol stack: If T-Online, addr is the address of the Gateway as a number. If TCP/IP, addr is the IP address of the HBCI server in dotted notation, e.g. "123.123.123.123". |
|
|
Adds a customer to the list of customers of this bank. If there already is an entry for this customer a Error will be thrown.
|
|
|
Returns the bank code of this bank. ("Bankleitzahl", BLZ) |
|
|
Return the version of the "Bank Parameter Daten" (BPD). The BPD contains information about the institute, such as address of the server, country code, bank code etc. If these data change on the server side then the server will increment this number. Upon next dialog initialisation this library checks the versions and receives the new BPD if necessary. |
|
|
Returns the ISO-3166 countrycode of this bank. In HBCI, "280" is still used for Germany according to the HBCI specs -- even though in the year 1990 the code was changed from 280 to 276 in ISO-3166. |
|
|
Remove a given institute message |
|
||||||||||||
|
Searches for an account in the banks internal list. No wildcards or jokers allowed.
|
|
|
Searches for a customer in the bank's internal list of users. No wildcards or jokers allowed.
|
|
||||||||||||||||
|
Searches for bank parameter data about a HBCI job which matches the given criteria.
|
|
|
Searches for a user in the bank's internal list. No wildcards or jokers allowed.
|
|
|
Returns the central HBCI object that controls the user interaction and version control. |
|
|
Returns the HBCI protocol version used with this bank. This HBCI version number is one out of the list<int> returned by supportedVersions(). This has been set by setHbciVersion, or, if it hasn't been set, it is some default value. |
|
|
Returns the language that is currently used in the dialog with this bank. Either this was set by setLanguage() or this is the bank's default language. |
|
|
Returns a list of languages supported by this bank. |
|
|
Returns a list of all institute messages that we received from the bank so far. This is a text message like an email. Your bank might send such a message containing usefull information concerning you account. They even might contain advertisements. That only depends on your bank.
|
|
|
Returns the name of this Bank. This name is the one that the bank sends back upon initally connecting. |
|
|
Removes an account from the internal list. FIXME: This method may not totally clean up all references to that account. This still has to be implemented one day. The object is not destroyed (since Pointers have automatic reference-counting). After this method call, the object is in the same state as one returned by HBCIAPI::accountFactory(). I.e. since it doesn't belong to any internal lists it is not allowed to be used in subsequent calls to HBCIAPI etc.
|
|
|
Removes a customer from the internal list. FIXME: This method may not totally clean up all references to that customer. This still has to be implemented one day. The object is not destroyed (since Pointers have automatic reference-counting). After this method call, the object is in the same state as one returned by HBCIAPI::customerFactory(). I.e. since it doesn't belong to any internal lists it is not allowed to be used in subsequent calls to HBCIAPI etc.
|
|
|
Set the communication address. Depends on type of protocol stack: For TCP/IP, addr is the IP address of the HBCI server in dotted notation, e.g. "123.123.123.123". |
|
|
Set the bank code of this bank. ("Bankleitzahl", BLZ) |
|
|
Set the version of the "Bank Parameter Daten" (BPD). Set it to "0" if you change the Bank's HBCI-Version because you need the up-to-date-BPD. They are automatically returned if BPD-Version=0 in the Init-Dialog. |
|
|
Set the ISO-3166 countrycode of this bank. (In HBCI: 280 for Germany) |
|
|
Set the HBCI protocol version to be used with this bank. |
|
|
Set the language that should be used in the dialog with this bank. |
|
|
Set the suffix of the communication address. For TCP/IP, this is ignored. |
|
|
Set the type of protocolstack for this bank: 1 == T-Online (ETSI 300 072); 2 == TCP/IP |
|
|
Returns the suffix of the communication address. Depends on type of protocol stack: If T-Online, suffix is the region code of the service. If TCP/IP, this is ignored. |
|
|
Returns a list of HBCI protocol versions that this bank supports. |
|
|
Returns the supported type of protocolstack: 1 == T-Online (ETSI 300 072); 2 == TCP/IP |
|
|
Returns the list of users of this bank.
|
1.2.17