---

HBCI::OutboxJobGetBalance Class Reference

Job that retrieves the balance of an Account. More...

#include <outboxaccjobs.h>

Inheritance diagram for HBCI::OutboxJobGetBalance:

[legend]List of all members.

Public Methods
	OutboxJobGetBalance (Pointer< Customer > c, Pointer< Account > a)
	~OutboxJobGetBalance ()
bool	createHBCIJobs (Pointer< MessageQueue > mbox, int n=0)
bool	evaluate ()
bool	commit (int msgNumber=HBCI_COMMIT_WHOLE_JOB)
string	description () const
JobProgressType	type () const
list< int >	resultCodes () const
const AccountBalance &	getBalance () const
	Returns the balance retrieved.
Static Public Methods
bool	isSupported (Pointer< Account > forAccount)
	Checks if getting the balance is supported for the specified account.

---

Detailed Description

Job that retrieves the balance of an Account.

This job retrieves the balance of one account.

Author:

Martin Preuss<martin@libchipcard.de>

---

Constructor & Destructor Documentation

HBCI::OutboxJobGetBalance::OutboxJobGetBalance (  Pointer< Customer >    c, Pointer< Account >    a )

HBCI::OutboxJobGetBalance::~OutboxJobGetBalance (    )

---

Member Function Documentation

bool HBCI::OutboxJobGetBalance::commit (  int    msgNumber = HBCI_COMMIT_WHOLE_JOB )  [virtual]

Call this method to commit changes to the system. Since Jobs do not change the system you may call this method to commit the changes. A job for getting the balance for example may decide to store the retrieved balance in the corresponding account. Parameters: msgNumber  Number of the message for which the response should be committed. As a job may consist of more than one message, it might be necessary to commit recieved changes before the rest of the job is sent. This method is called for each message and finally for the whole job (if called for the whol job, msgNumber is set to HBCI_COMMIT_WHOLE_JOB) Author: Martin Preuss<martin@libchipcard.de> Returns : true on success, false otherwise Implements HBCI::OutboxJob.

bool HBCI::OutboxJobGetBalance::createHBCIJobs (  Pointer< MessageQueue >    mbox, int    n = 0 )  [virtual]

Let the job create the "real" jobs and add them to the message queue given. Author: Martin Preuss<martin@libchipcard.de> Returns : true on success, false otherwise Parameters: mbox  pointer to the messagebox to add the jobs to n  the number of the message to create. In most cases this is zero. Implements HBCI::OutboxJob.

string HBCI::OutboxJobGetBalance::description (    )  const [virtual]

Return a short description of what the job is supposed to do. Author: Martin Preuss<martin@libchipcard.de> Implements HBCI::OutboxJob.

bool HBCI::OutboxJobGetBalance::evaluate (    )  [virtual]

Let the job check the result and set the flags. Let the job check the result. This means checking the results of all Jobs involved (which otherwise is not done automatically). This method sets its status and result accordingly -- otherwise the status and result flags might not be up-to-date. Author: Martin Preuss<martin@libchipcard.de> Returns : true if job was successfull, false otherwise Implements HBCI::OutboxJob.

const AccountBalance& HBCI::OutboxJobGetBalance::getBalance (    )  const

Returns the balance retrieved.

bool HBCI::OutboxJobGetBalance::isSupported (  Pointer< Account >    forAccount )  [static]

Checks if getting the balance is supported for the specified account. If this method returns <false>, your application should provide a way to allow this job anyway because some banks just don't tell you that they support this job for the specified account. Only if <true> is returned, you can be sure this job is supported.

list<int> HBCI::OutboxJobGetBalance::resultCodes (    )  const [virtual]

Returns a list of result codes of this job. This can be used to get more detailed information if the result of this job was HBCI_JOB_RESULT_FAILED. In that case, you can traverse this list, checking for resultcodes >= 9000. Each of those can be the source of the job failure, so you can react accordingly. HBCI spec suggests that the most important of them can be found at the front() already, but that depends on your bank. Note: A resultcode >= 9000 does not automatically mean an error, see MessageQueue::getResult(). See also: MessageQueue::getResult(), Job::errorcodeIsLibraryBug() Implements HBCI::OutboxAccountJob.

JobProgressType HBCI::OutboxJobGetBalance::type (    )  const [inline, virtual]

Return the JobProgressType of this job. Author: Christian Stimming <stimming@tuhh.de> Implements HBCI::OutboxJob.

---

The documentation for this class was generated from the following file:

• outboxaccjobs.h

---