Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

HBCI::Account Class Reference

The abstract base class for an account in OpenHBCI. More...

#include <account.h>

List of all members.

Public Methods

 Account ()
virtual ~Account ()
Account identification
virtual Pointer< Bankbank () const=0
virtual const string & accountId () const=0
virtual const string & accountSuffix () const=0
virtual const string & instituteCode () const=0
virtual int countryCode () const=0
Account information
virtual const string & name1 () const=0
 Returns the name of the owner of this account.

virtual const string & name2 () const=0
 Returns the second part of the name of the owner of this account.

virtual const string & accountName () const=0
 Returns the name of this account.

virtual const string & currency () const=0
Authorized Customers
virtual const list< Pointer<
Customer > > & 
authorizedCustomers () const=0
virtual void addAuthorizedCustomer (Pointer< Customer > c)=0
virtual bool isAuthorized (const Pointer< Customer > c) const=0
Financial Application Data
virtual const AccountBalancebalance () const=0
virtual const list< Transaction > & transactions () const=0
virtual void clearTransactions ()=0
virtual const list< StandingOrder > & standingOrders () const=0
virtual void clearStandingOrders ()=0
virtual void addStandingOrder (const StandingOrder &o)=0
Account Management Enabled
virtual bool managed () const=0
virtual void setManaged (bool m)=0
General limit
virtual const Limitlimit ()=0


Detailed Description

The abstract base class for an account in OpenHBCI.

This is the abstract base class for an account in OpenHBCI. You can't create an object of this class directly; instead, use the factory method provided in API::accountFactory. Internally this class uses another class as implementation.

Author:
Martin Preuss<openhbci@aquamaniac.de>


Constructor & Destructor Documentation

HBCI::Account::Account  
 

Constructor

virtual HBCI::Account::~Account   [virtual]
 

Destructor


Member Function Documentation

virtual const string& HBCI::Account::accountId   const [pure virtual]
 

Returns the account ID ("Kontonummer") of this account.

virtual const string& HBCI::Account::accountName   const [pure virtual]
 

Returns the name of this account.

This is set by the bank.

virtual const string& HBCI::Account::accountSuffix   const [pure virtual]
 

Returns the account ID suffix of this account.

Returns the account ID suffix of this account. This new in HBCI 2.2; this field is only set by a few institutes

virtual void HBCI::Account::addAuthorizedCustomer Pointer< Customer   c [pure virtual]
 

Adds an authorized customer to this account.

virtual void HBCI::Account::addStandingOrder const StandingOrder   o [pure virtual]
 

Adds a standing order to the list of standing orders.

If there already is a standing order with the the same job id then it will be overwritten.

This operation only makes sense if you configure OpenHBCI such that it stores the standing orders.

Author:
Martin Preuss<martin@libchipcard.de>

virtual const list<Pointer<Customer> >& HBCI::Account::authorizedCustomers   const [pure virtual]
 

Returns the list of Customers that are authorized to sign.

Returns the list of Customers that are authorized to sign (other expression: have signatory power) jobs/transactions on this account.

virtual const AccountBalance& HBCI::Account::balance   const [pure virtual]
 

Returns the balance at the last time you checked it.

Returns the balance of this account at the last time you checked it, if you configure OpenHBCI such that it stores this balance.

virtual Pointer<Bank> HBCI::Account::bank   const [pure virtual]
 

Returns a pointer to the bank that this account belongs to.

virtual void HBCI::Account::clearStandingOrders   [pure virtual]
 

Clears the list of standing orders.

virtual void HBCI::Account::clearTransactions   [pure virtual]
 

Clears the list of transactions.

virtual int HBCI::Account::countryCode   const [pure virtual]
 

Returns the country code of the bank of this account.

Note: When creating a Transaction... do not use Account::bank().ref().countryCode() but instead use Account::countryCode(). The reason is that the country code stored along with the account object may differ from the code stored along with the bank object. (Don't blame openHBCI for this fact.)

virtual const string& HBCI::Account::currency   const [pure virtual]
 

Returns the default currency of this account (DEM, EUR)

virtual const string& HBCI::Account::instituteCode   const [pure virtual]
 

Returns the institute code (bank code, BLZ) of this account.

Note: When creating a Transaction... do not use Account::bank().ref().bankCode() but instead use Account::instituteCode(). The reason is that the institute code stored along with the account object may differ from the code stored along with the bank object. (Don't blame openHBCI for this fact.)

virtual bool HBCI::Account::isAuthorized const Pointer< Customer   c const [pure virtual]
 

Returns true if the given Customer is authorized to sign.

Returns true if the given Customer is authorized to sign jobs/transactions for this account.

virtual const Limit& HBCI::Account::limit   [pure virtual]
 

Returns the general limit for this account, if it has one. If not, limit().isValid()=false.

virtual bool HBCI::Account::managed   const [pure virtual]
 

Returns true, if this account is to be managed by OpenHBCI.

FIXME: Is this correct or is the boolean value the other way round? Also, this is currently not really implemented.

You might want to set this to false if your bank does offer you to manage this account through HBCI, but for whatever reason you don't want to do this through this API. Deleting such an account by removeAccount wouldn't help you, since at the next UPD (user parameter data) update, which contain the list of accounts, this account would pop up again in OpenHBCI.

virtual const string& HBCI::Account::name1   const [pure virtual]
 

Returns the name of the owner of this account.

Unfortunately this has no standard relation to the customers that are allowed to use this account.

virtual const string& HBCI::Account::name2   const [pure virtual]
 

Returns the second part of the name of the owner of this account.

virtual void HBCI::Account::setManaged bool    m [pure virtual]
 

Set whether this account is to be managed by OpenHBCI.

virtual const list<StandingOrder>& HBCI::Account::standingOrders   const [pure virtual]
 

Returns the list of standing orders up to the last time you checked it.

Returns a list of standing orders of this account, if you configure OpenHBCI such that it stores them.

Author:
Martin Preuss<martin@libchipcard.de>

virtual const list<Transaction>& HBCI::Account::transactions   const [pure virtual]
 

Returns the list of transactions up to the last time you checked it.

Returns the list of transactions of this account up to the last time you checked it, if you configure OpenHBCI such that it stores them.


The documentation for this class was generated from the following file:
Generated on Mon Jun 23 13:41:09 2003 for openhbci by doxygen1.2.17