---

HBCI::OutboxJobDebitNote Class Reference

Job that issues a debit note in favor of a Account. More...

#include <outboxaccjobs.h>

Inheritance diagram for HBCI::OutboxJobDebitNote:

[legend]List of all members.

Public Methods
	OutboxJobDebitNote (Pointer< Customer > c, Pointer< Account > a, Transaction xa)
	~OutboxJobDebitNote ()
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 Transaction &	transaction () const
virtual int	segmentForStatusReport () const
Static Public Methods
bool	isSupported (Pointer< Account > forAccount)
	Checks if making a debit note is supported for the specified account.
const Limit	limit (Pointer< Account > forAccount)
	Returns the limit for debit notes.

---

Detailed Description

Job that issues a debit note in favor of a Account.

This job draws money from a foreign account to one of yours. You'll need to sign a special contract with your credit institute to enable this feature.

Author:

Martin Preuss<martin@libchipcard.de>

---

Constructor & Destructor Documentation

HBCI::OutboxJobDebitNote::OutboxJobDebitNote (  Pointer< Customer >    c, Pointer< Account >    a, Transaction    xa )

HBCI::OutboxJobDebitNote::~OutboxJobDebitNote (    )

---

Member Function Documentation

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

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

Checks if making a debit note 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.

const Limit HBCI::OutboxJobDebitNote::limit (  Pointer< Account >    forAccount )  [static]

Returns the limit for debit notes. Note: Not all banks tell us about the existance of a limit. There might be a limit for this job even if limit().isValid()==false!

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

virtual int HBCI::OutboxJobDebitNote::segmentForStatusReport (    )  const [virtual]

Returns the number of the segment to be used for status reports. Returns "-1" as default, meaning no segment number (NOTE: In this case the corresponding field in HKPRO will be left out) Reimplemented from HBCI::OutboxJob.

const Transaction& HBCI::OutboxJobDebitNote::transaction (    )  const [inline]

Return the transaction (debit note) this job is/was supposed to perform. Author: Martin Preuss<martin@libchipcard.de>

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

---