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

HBCI::StatusReport Class Reference

Status information about one particular message. More...

#include <statusreport.h>

List of all members.

Public Methods

 StatusReport ()
 ~StatusReport ()
Date and Time
const Datedate () const
void setDate (const Date &d)
const Timetime () const
void setTime (const Time &t)
Result information
int result () const
void setResult (int r)
const string & resultText () const
void setResultText (const string &s)
string dump () const
Reference to the original HBCI::OutboxJob
const MessageReferencemessageReference () const
void setMessageReference (const MessageReference &r)
int segment () const
void setSegment (int s)
const string & groupReference () const
void setGroupReference (const string &s)


Detailed Description

Status information about one particular message.

This Statusreport contains the bank's information about what happened with the message (e.g. transfer order) references by the messageReference().


Constructor & Destructor Documentation

HBCI::StatusReport::StatusReport  
 

HBCI::StatusReport::~StatusReport  
 


Member Function Documentation

const Date& HBCI::StatusReport::date   const [inline]
 

Returns the date when this status report was valid.

string HBCI::StatusReport::dump   const
 

Returns a long string containing all information of this status report; mainly intended for debugging.

const string& HBCI::StatusReport::groupReference   const [inline]
 

Returns the message group this status report belongs to (FIXME: is this correct?)

const MessageReference& HBCI::StatusReport::messageReference   const [inline]
 

Returns the message reference to find the message that this status report belongs to, i.e. the reference that was given previously in OutboxJob::messageReference().

int HBCI::StatusReport::result   const [inline]
 

Returns the HBCI result code of this status report.

const string& HBCI::StatusReport::resultText   const [inline]
 

Returns the clear text message of this status report.

int HBCI::StatusReport::segment   const [inline]
 

Returns the segment number inside the referred message (by messageReference() ) that this status report belongs to. This is the segment number from OutboxJob::segmentForStatusReport(). (FIXME: is this correct?)

void HBCI::StatusReport::setDate const Date   d [inline]
 

void HBCI::StatusReport::setGroupReference const string &    s [inline]
 

void HBCI::StatusReport::setMessageReference const MessageReference   r [inline]
 

void HBCI::StatusReport::setResult int    r [inline]
 

void HBCI::StatusReport::setResultText const string &    s [inline]
 

void HBCI::StatusReport::setSegment int    s [inline]
 

void HBCI::StatusReport::setTime const Time   t [inline]
 

const Time& HBCI::StatusReport::time   const [inline]
 

Returns the time when this status report was valid.


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