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

HBCI::AccountBalance Class Reference

Stores all values/balances of an Account as sent to us by the Bank. More...

#include <balance.h>

List of all members.

Public Methods

 AccountBalance ()
 ~AccountBalance ()
void dump ()
 Dumps the data of this object to stderr.

Balance
void setBookedBalance (const Balance &b)
const Balance & bookedBalance () const
 Returns the booked Balance.

void setNotedBalance (const Balance &b)
const Balance & notedBalance () const
 Returns the noted Balance (which is probably more up-to-date than the booked balance).

void setCurrency (const string &s)
const string & currency () const
 Returns the ISO-4217 currency string of this account balance.

Overdraft
void setBankLine (const Value &v)
const Value & bankLine () const
 Returns the bank line (limit value) for this account.

void setDisposable (const Value &v)
const Value & disposable () const
 Returns the amount that is still at your disposal in this account.

void setDisposed (const Value &v)
const Value & disposed () const
 Returns the amount that is already disposed.

Date and Time
const Date & date () const
void setDate (const Date &d)
const Time & time () const
void setTime (const Time &t)

Friends

class SEGBalance


Detailed Description

Stores all values/balances of an Account as sent to us by the Bank.

This class stores the balances of your account. An Account usually has several different balances at the same time (e.g. booked/noted balance). You can query it from the institute by sending the OutboxJobGetBalance (using the lowlevel job JOBGetBalance).


Constructor & Destructor Documentation

HBCI::AccountBalance::AccountBalance (    ) 
 

Empty Constructor.

HBCI::AccountBalance::~AccountBalance (    ) 
 

Default Destructor.


Member Function Documentation

const Value& HBCI::AccountBalance::bankLine (    )  const [inline]
 

Returns the bank line (limit value) for this account.

I.e. the money your balance is allowed to go negative.

const Balance& HBCI::AccountBalance::bookedBalance (    )  const [inline]
 

Returns the booked Balance.

The booked balance is the balance including all transactions that are booked, i.e. that are "really" executed.

const string& HBCI::AccountBalance::currency (    )  const [inline]
 

Returns the ISO-4217 currency string of this account balance.

const Date& HBCI::AccountBalance::date (    )  const [inline]
 

Returns the Date when this balance was created.

const Value& HBCI::AccountBalance::disposable (    )  const [inline]
 

Returns the amount that is still at your disposal in this account.

If the difference between your current balance (whether noted or booked depends on the conditions of your bank) and the bank line value results in a positive amount, then you have money left at your disposal. (Which is [hopefully] the usual case.)

const Value& HBCI::AccountBalance::disposed (    )  const [inline]
 

Returns the amount that is already disposed.

FIXME: exakt meaning still unknown. hmm, we will se when first data arrive, i don't know yet

void HBCI::AccountBalance::dump (    ) 
 

Dumps the data of this object to stderr.

Useful for debuggin purposes.

const Balance& HBCI::AccountBalance::notedBalance (    )  const [inline]
 

Returns the noted Balance (which is probably more up-to-date than the booked balance).

The noted balance includes all transactions from the booked, plus those transactions which the bank has noted for execution but are not yet "really" executed.

void HBCI::AccountBalance::setBankLine (  const Value &    v )  [inline]
 

Set the limit value you have on this account.

void HBCI::AccountBalance::setBookedBalance (  const Balance &    b )  [inline]
 

Set the booked balance.

Parameters:
b  The booked balance.

void HBCI::AccountBalance::setCurrency (  const string &    s )  [inline]
 

Sets the ISO-4217 currency string of this account balance.

Parameters:
s  The currency of this balance.

void HBCI::AccountBalance::setDate (  const Date &    d )  [inline]
 

Set the Date when this balance was created.

Parameters:
d  New date.

void HBCI::AccountBalance::setDisposable (  const Value &    v )  [inline]
 

Set the amount that is still at your disposal in this account.

Parameters:
v  The amount at your disposal.

void HBCI::AccountBalance::setDisposed (  const Value &    v )  [inline]
 

Set the amount that is already disposed.

Parameters:
v  New disposed value.

void HBCI::AccountBalance::setNotedBalance (  const Balance &    b )  [inline]
 

Set the noted balance.

Parameters:
b  The noted balance.

void HBCI::AccountBalance::setTime (  const Time &    t )  [inline]
 

Set the Time when this balance was created.

Parameters:
t  New Time.

const Time& HBCI::AccountBalance::time (    )  const [inline]
 

Returns the Time when this balance was created.


Friends And Related Function Documentation

friend class SEGBalance [friend]
 


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