---

HBCI::OutboxJobGetStatusReports Class Reference

Job that retrieves all Transaction's of one Account. More...

#include <outboxjobs.h>

Inheritance diagram for HBCI::OutboxJobGetStatusReports:

[legend]List of all members.

Public Methods
	OutboxJobGetStatusReports (Pointer< Customer > c, const Date &fromDate, const Date &todate, int maxEntries)
	~OutboxJobGetStatusReports ()
bool	createHBCIJobs (Pointer< MessageQueue > mbox, int n=0)
bool	evaluate ()
bool	stillMessagesToSend (int nextMsg) const
bool	commit (int msgNumber=HBCI_COMMIT_WHOLE_JOB)
string	description () const
JobProgressType	type () const
list< int >	resultCodes () const
const list< StatusReport > &	statusReports () const
	Returns the list of status reports that this job retrieved.

---

Detailed Description

Job that retrieves all Transaction's of one Account.

This job retrieves the transactions of one account.

Author:

Martin Preuss<martin@libchipcard.de>

---

Constructor & Destructor Documentation

HBCI::OutboxJobGetStatusReports::OutboxJobGetStatusReports (  Pointer< Customer >    c, const Date &    fromDate, const Date &    todate, int    maxEntries )

This job retrieves a list of transaction statements from the server. Author: Martin Preuss<martin@libchipcard.de> Parameters: c  Customer that invokes this job. fromDate  date of the first day you want to inspect, if invalid then the first possible date will be used. Please note that some banks NEED this date to be set todate  date of the last day you want to inspect, if invalid then the current date will be used. maxEntries  The maximum number of entries that should be fetched.

HBCI::OutboxJobGetStatusReports::~OutboxJobGetStatusReports (    )

---

Member Function Documentation

bool HBCI::OutboxJobGetStatusReports::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::OutboxJobGetStatusReports::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::OutboxJobGetStatusReports::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::OutboxJobGetStatusReports::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.

list<int> HBCI::OutboxJobGetStatusReports::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::OutboxJob.

const list<StatusReport>& HBCI::OutboxJobGetStatusReports::statusReports (    )  const [inline]

Returns the list of status reports that this job retrieved.

bool HBCI::OutboxJobGetStatusReports::stillMessagesToSend (  int    nextMsg )  const [virtual]

Returns true if there are still messages to be sent. Checks if there are still messages to be sent. This is needed because some jobs don't know the number of messages they consist of, until they are executed. Parameters: nextMsg  The number (starting with 0) of the message that would be sent next Returns : true If there are unsent messages left Author: Fabian Kaiser<openhbci@derzach.de> Reimplemented from HBCI::OutboxJob.

JobProgressType HBCI::OutboxJobGetStatusReports::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:

• outboxjobs.h

---