---

HBCI::StandingOrder Class Reference

Holds all the data of a Standing Order in HBCI. More...

#include <standingorder.h>

Inheritance diagram for HBCI::StandingOrder:

[legend]List of all members.

Public Methods
	StandingOrder (const string &s, Pointer< Account > account)
	StandingOrder (Pointer< Account > account)
	StandingOrder ()
bool	operator== (const StandingOrder &otherOrder) const
Order Identification
const string &	jobIdentification () const
void	setJobIdentification (const string &s)
Execution Date
const Date &	firstExecutionDate () const
void	setFirstExecutionDate (const Date &ex)
const Date &	lastExecutionDate () const
void	setLastExecutionDate (const Date &ex)
const Date &	executionDate () const
void	setExecutionDate (const Date &ex)
int	cycle () const
void	setCycle (int v=1)
int	period () const
void	setPeriod (int c=EXECUTE_MONTHLY)
int	execDay () const
void	setExecDay (int d=1)
Our account
int	ourCountryCode () const
void	setOurCountryCode (int i)
const string &	ourBankCode () const
void	setOurBankCode (const string &code)
const string &	ourAccountId () const
void	setOurAccountId (const string &id)
const string &	ourSuffix () const
void	setOurSuffix (const string &id)
Value
const Value &	value () const
void	setValue (const Value &v)
Order Description
int	transactionCode () const
void	setTransactionCode (int c)
const list< string > &	description () const
void	addDescription (const string &s)
Other account
int	otherCountryCode () const
void	setOtherCountryCode (int i)
const string &	otherBankCode () const
void	setOtherBankCode (const string &s)
const string &	otherAccountId () const
void	setOtherAccountId (const string &s)
const string &	otherSuffix () const
void	setOtherSuffix (const string &id)
const list< string > &	otherName () const
void	addOtherName (const string &s)
Static Public Attributes
const int	EXECUTE_WEEKLY
const int	EXECUTE_MONTHLY

---

Detailed Description

Holds all the data of a Standing Order in HBCI.

A Standing Order is stored at the bank and regularly invokes a transaction in your account.

Note: Some data members have comments referencing the SWIFT MT940 specification, but IIRC this is not the right specification for a standing order. FIXME: Add clear references about which specifications set the rules for interpretation of each data member.

Author:

Fabian Kaiser<openhbci@derzach.de>

---

Constructor & Destructor Documentation

HBCI::StandingOrder::StandingOrder (  const string &    s, Pointer< Account >    account )

HBCI::StandingOrder::StandingOrder (  Pointer< Account >    account )

HBCI::StandingOrder::StandingOrder (    )

---

Member Function Documentation

void HBCI::StandingOrder::addDescription (  const string &    s )  [virtual]

Set a textual description See also: maxDescriptionLines() for valid values Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::addOtherName (  const string &    s )  [virtual]

Set the name of the recipient. Two strings can be set for this, so call this method not more than two times. Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::cycle (    )  const

Returns the numer of time-units that have to elaps between two executions of this order. See also: setPeriod(int) For the time-unit

const list<string>& HBCI::StandingOrder::description (    )  const [virtual]

Returns a list of string describing this order Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::execDay (    )  const

Returns the day within a week or a month (depending on period()) when this order should be executed. See also: execDaysMonth(), execDaysWeek() for valid values

const Date& HBCI::StandingOrder::executionDate (    )  const

Returns the date when this order will be executed next time

const Date& HBCI::StandingOrder::firstExecutionDate (    )  const

Return the date when this order is/was executed for the first time

const string& HBCI::StandingOrder::jobIdentification (    )  const

Returns a string that identifies this standing order. Use this identification to name an order you want to modify. Note: It is safe to store this id within the application. It is valid until the order is getting deleted (at the bank)

const Date& HBCI::StandingOrder::lastExecutionDate (    )  const

Return the date when this order is executed the last time

bool HBCI::StandingOrder::operator== (  const StandingOrder &    otherOrder )  const

Checks if two standing orders are equal. Some banks do not support the jobId, so you have to specify all order-data. Using all this data, two jobs are compared.

const string& HBCI::StandingOrder::otherAccountId (    )  const [virtual]

Returns the account number of the recipient. To this account, money is transfered. Implements HBCI::AbstractTrans.

const string& HBCI::StandingOrder::otherBankCode (    )  const [virtual]

Returns the code of the institute which hold the recipient's account Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::otherCountryCode (    )  const [virtual]

Return the country code of the recipient's bank, according to ISO 3166 Note: For Germany, it is 280 in HBCI. Implements HBCI::AbstractTrans.

const list<string>& HBCI::StandingOrder::otherName (    )  const [virtual]

Returns the names of the recipient Implements HBCI::AbstractTrans.

const string& HBCI::StandingOrder::otherSuffix (    )  const [virtual]

Returns a suffix to the account number to which the money shall be tranfered. Normaly not used. Implements HBCI::AbstractTrans.

const string& HBCI::StandingOrder::ourAccountId (    )  const [virtual]

Your account number; up to 23 characters. Note: possibly including the currency (yes, that's what MT940 says) -- MT940: Kontonummer in :25: Implements HBCI::AbstractTrans.

const string& HBCI::StandingOrder::ourBankCode (    )  const [virtual]

bank code of your institute (BLZ or S.W.I.F.T. code) -- MT940: BLZ in :25: Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::ourCountryCode (    )  const [virtual]

country code of your institute -- MT940: not in MT940 Implements HBCI::AbstractTrans.

const string& HBCI::StandingOrder::ourSuffix (    )  const [virtual]

If your account has subaccounts which are distinguished by different suffixes, then this is that suffix. Otherwise it's empty. -- MT940: not in MT940 Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::period (    )  const

Returns whether the time-unit for cycle() is a week or a month

void HBCI::StandingOrder::setCycle (  int    v = 1 )

Set the numer of time-units that have to elaps between two executions of this order. See also: setPeriod(int) For the time-unit , monthlyCycle(), weeklyCycle() for valid values

void HBCI::StandingOrder::setExecDay (  int    d = 1 )

Set the day of week/month (depending on period()) when this order should be executed. Note: It must be consistent with firstExecutionDate() and period()

void HBCI::StandingOrder::setExecutionDate (  const Date &    ex )

Only used when modifying an order. Set the date when the modified order should be executed for the first time See also: minDaysToExec(), maxDaysToExec() for valid values

void HBCI::StandingOrder::setFirstExecutionDate (  const Date &    ex )

Set the date when this order should be executed for the first time Note: It must be consistent with period() and execDay() See also: minDaysToExec(), maxDaysToExec() for valid values

void HBCI::StandingOrder::setJobIdentification (  const string &    s )

Set a string that identifies this standing order. Use this identification to name an order you want to modify.

void HBCI::StandingOrder::setLastExecutionDate (  const Date &    ex )

Set the date when this order should be executed the last time

void HBCI::StandingOrder::setOtherAccountId (  const string &    s )  [virtual]

Set the account number to which the money shall be transfered Parameters: s  The account number Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOtherBankCode (  const string &    s )  [virtual]

Set the code of the bank which hold the recipient's account. Parameters: s  The institute code Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOtherCountryCode (  int    i )  [virtual]

Set the country code of the recipient's bank Parameters: i  The country code according to ISO 3166 Note: For Germany, it is 280 in HBCI. Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOtherSuffix (  const string &    id )  [virtual]

Set a suffix to the account number to which the money shall be tranfered. Normaly not used. Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOurAccountId (  const string &    id )  [virtual]

Your account number; up to 23 characters. Note: possibly including the currency (yes, that's what MT940 says) -- MT940: Kontonummer in :25: Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOurBankCode (  const string &    code )  [virtual]

bank code of your institute (BLZ or S.W.I.F.T. code) -- MT940: BLZ in :25: Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOurCountryCode (  int    i )  [virtual]

country code of your institute -- MT940: not in MT940 Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setOurSuffix (  const string &    id )  [virtual]

If your account has subaccounts which are distinguished by different suffixes, then this is that suffix. Otherwise it's empty. -- MT940: not in MT940 Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setPeriod (  int    c = EXECUTE_MONTHLY )

Set the time-unit for cycle() to week or month Note: It must be consistent with firstExecutionDate() and execDay()

void HBCI::StandingOrder::setTransactionCode (  int    c )  [virtual]

Set the type of order. Should be 52 in most cases Implements HBCI::AbstractTrans.

void HBCI::StandingOrder::setValue (  const Value &    v )  [virtual]

Set the order's value Implements HBCI::AbstractTrans.

int HBCI::StandingOrder::transactionCode (    )  const [virtual]

Returns a code that identifies the type of order This should be 52 in most cases Implements HBCI::AbstractTrans.

const Value& HBCI::StandingOrder::value (    )  const [virtual]

Returns the order's value Implements HBCI::AbstractTrans.

---

Member Data Documentation

const int HBCI::StandingOrder::EXECUTE_MONTHLY [static]

See also: setPeriod() , period()

const int HBCI::StandingOrder::EXECUTE_WEEKLY [static]

See also: setPeriod() , period()

---

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

• standingorder.h

---