---

HBCI::instituteMessage Class Reference

A message sent to us by the bank. More...

#include <bank.h>

List of all members.

Public Methods
	instituteMessage ()
	~instituteMessage ()
const bool	operator== (const instituteMessage &msg)
const Date &	date () const
void	setDate (const Date &d)
const Time &	time () const
void	setTime (const Time &t)
const string &	subject () const
void	setSubject (const string &t)
const string &	text () const
void	setText (const string &t)
int	country () const
void	setCountry (int i)
const string &	bankCode () const
void	setBankCode (const string &s)
bool	read () const
void	setRead (bool b)

---

Detailed Description

A message sent to us by the bank.

This class is a message sent to us by the credit institute. It occurs when performing the opening of a dialog (JOBDialogInit, JOBFirstInit) and can contain all sorts of information that the bank thinks is important (even advertisements).

Author:

Martin Preuss <openhbci@aquamaniac.de>

---

Constructor & Destructor Documentation

HBCI::instituteMessage::instituteMessage (    )

HBCI::instituteMessage::~instituteMessage (    )

---

Member Function Documentation

const string& HBCI::instituteMessage::bankCode (    )  const [inline]

Returns the Bank code ("BLZ") of the bank that sent this message (to identify it) Note: When creating a Transaction... don't use Account.bank().ref().bankCode() but use Account.instituteCode(). The reason is, that the institute code stored along with the account object may differ from the code stored along with the bank object (don't blame openHBCI for this fact)

int HBCI::instituteMessage::country (    )  const [inline]

Returns the ISO-3166 country code of the bank that sent this message (to identify it) Note: When creating a Transaction... don't use Account.bank().ref().countryCode() but use Account.countryCode(). The reason is, that the country code stored along with the account object may differ from the code stored along with the bank object (don't blame openHBCI for this fact)

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

Returns the Date of arrival.

const bool HBCI::instituteMessage::operator== (  const instituteMessage &    msg )

bool HBCI::instituteMessage::read (    )  const [inline]

Helper flag: Returns true if message has been read. However, this is neither set nor reset by OpenHBCI. The state of the flag is stored (FIXME: is this correct), but the application has to manage the flag by itself.

void HBCI::instituteMessage::setBankCode (  const string &    s )  [inline]

Set the Bank code ("BLZ") of the bank that sent this message (to identify it)

void HBCI::instituteMessage::setCountry (  int    i )  [inline]

Set the ISO-3166 country code of the bank that sent this message (to identify it)

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

Set the Date of arrival.

void HBCI::instituteMessage::setRead (  bool    b )  [inline]

Set the flag that shows whether this message has been read. See read().

void HBCI::instituteMessage::setSubject (  const string &    t )  [inline]

Set the subject of this message.

void HBCI::instituteMessage::setText (  const string &    t )  [inline]

Set the text of the message.

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

Set the Time of arrival.

const string& HBCI::instituteMessage::subject (    )  const [inline]

Returns the subject of this message.

const string& HBCI::instituteMessage::text (    )  const [inline]

Returns the text of the message, just as it was sent by the bank.

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

Returns the Time of arrival.

---

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

• bank.h

---