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

HBCI_StandingOrder


List of HBCI_StandingOrder

typedef void *(* list_HBCI_StO_cb )(const HBCI_StandingOrder *sto, void *user_data)
void list_HBCI_StO_delete (list_HBCI_StO *l)
int list_HBCI_StO_size (const list_HBCI_StO *l)
void list_HBCI_StO_iter_delete (list_HBCI_StO_iter *l)
list_HBCI_StO_iter * list_HBCI_StO_begin (const list_HBCI_StO *l)
list_HBCI_StO_iter * list_HBCI_StO_end (const list_HBCI_StO *l)
const HBCI_StandingOrder * list_HBCI_StO_iter_get (const list_HBCI_StO_iter *l)
void list_HBCI_StO_iter_next (list_HBCI_StO_iter *l)
int list_HBCI_StO_iter_equal (const list_HBCI_StO_iter *l1, const list_HBCI_StO_iter *l2)
void * list_HBCI_StO_foreach (const list_HBCI_StO *list, list_HBCI_StO_cb func, void *user_data)

Order Identification

const char * HBCI_StandingOrder_jobIdentification (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setJobIdentification (HBCI_StandingOrder *h, const char *s)

Execution Date

const HBCI_Date * HBCI_StandingOrder_firstExecutionDate (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setFirstExecutionDate (HBCI_StandingOrder *h, const HBCI_Date *ex)
const HBCI_Date * HBCI_StandingOrder_lastExecutionDate (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setLastExecutionDate (HBCI_StandingOrder *h, const HBCI_Date *ex)
const HBCI_Date * HBCI_StandingOrder_executionDate (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setExecutionDate (HBCI_StandingOrder *h, const HBCI_Date *ex)
int HBCI_StandingOrder_cycle (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setCycle (HBCI_StandingOrder *h, int v)
int HBCI_StandingOrder_period (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setPeriod (HBCI_StandingOrder *h, int c)
int HBCI_StandingOrder_execDay (const HBCI_StandingOrder *h)
void HBCI_StandingOrder_setExecDay (HBCI_StandingOrder *h, int d)

Our account

int HBCI_StandingOrder_ourCountryCode (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOurCountryCode (HBCI_StandingOrder *t, int i)
const char * HBCI_StandingOrder_ourBankCode (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOurBankCode (HBCI_StandingOrder *t, const char *code)
const char * HBCI_StandingOrder_ourAccountId (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOurAccountId (HBCI_StandingOrder *t, const char *id)
const char * HBCI_StandingOrder_ourSuffix (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOurSuffix (HBCI_StandingOrder *t, const char *id)

Value

const HBCI_Value * HBCI_StandingOrder_value (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setValue (HBCI_StandingOrder *t, const HBCI_Value *v)

StandingOrder Description

int HBCI_StandingOrder_transactionCode (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setTransactionCode (HBCI_StandingOrder *t, int c)
const list_string * HBCI_StandingOrder_description (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_addDescription (HBCI_StandingOrder *t, const char *s)

Other account

int HBCI_StandingOrder_otherCountryCode (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOtherCountryCode (HBCI_StandingOrder *t, int i)
const char * HBCI_StandingOrder_otherBankCode (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOtherBankCode (HBCI_StandingOrder *t, const char *s)
const char * HBCI_StandingOrder_otherAccountId (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOtherAccountId (HBCI_StandingOrder *t, const char *s)
const char * HBCI_StandingOrder_otherSuffix (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_setOtherSuffix (HBCI_StandingOrder *t, const char *id)
const list_string * HBCI_StandingOrder_otherName (const HBCI_StandingOrder *t)
void HBCI_StandingOrder_addOtherName (HBCI_StandingOrder *t, const char *s)

Typedefs

typedef HBCI::StandingOrder HBCI_StandingOrder
typedef list< HBCI::Pointer<
HBCI::StandingOrder > > 		list_HBCI_StO
typedef list< HBCI::Pointer<
HBCI::StandingOrder
> >::const_iterator 		list_HBCI_StO_iter

Functions

HBCI_StandingOrder * HBCI_StandingOrder_new ()
void HBCI_StandingOrder_delete (HBCI_StandingOrder *t)

Typedef Documentation

typedef struct HBCI::StandingOrder HBCI_StandingOrder
 

typedef list<HBCI::Pointer<HBCI::StandingOrder> > list_HBCI_StO
 

typedef void*(* list_HBCI_StO_cb)(const HBCI_StandingOrder *sto, void *user_data)
 

Callback function for list_HBCI_StO_foreach.

typedef list<HBCI::Pointer<HBCI::StandingOrder> >::const_iterator list_HBCI_StO_iter
 

Function Documentation

void HBCI_StandingOrder_addDescription (  HBCI_StandingOrder *    t,
const char *    s
) 
 

void HBCI_StandingOrder_addOtherName (  HBCI_StandingOrder *    t,
const char *    s
) 
 

int HBCI_StandingOrder_cycle (  const HBCI_StandingOrder *    h ) 
 

Returns the numer of time-units that have to elaps between two executions of this order.

See also:
setPeriod(int) For the time-unit

void HBCI_StandingOrder_delete (  HBCI_StandingOrder *    t ) 
 

Destructor

const list_string* HBCI_StandingOrder_description (  const HBCI_StandingOrder *    t ) 
 

Description of what this transaction is for, and how the Bank describes this transaction. -- Verwendungszweck; fields 20-29 and 60-63 in field :86:

int HBCI_StandingOrder_execDay (  const HBCI_StandingOrder *    h ) 
 

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 HBCI_Date* HBCI_StandingOrder_executionDate (  const HBCI_StandingOrder *    h ) 
 

Returns the date when this order will be executed next time

const HBCI_Date* HBCI_StandingOrder_firstExecutionDate (  const HBCI_StandingOrder *    h ) 
 

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

const char* HBCI_StandingOrder_jobIdentification (  const HBCI_StandingOrder *    h ) 
 

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 HBCI_Date* HBCI_StandingOrder_lastExecutionDate (  const HBCI_StandingOrder *    h ) 
 

Return the date when this order is executed the last time

HBCI_StandingOrder* HBCI_StandingOrder_new (    ) 
 

Constructor

const char* HBCI_StandingOrder_otherAccountId (  const HBCI_StandingOrder *    t ) 
 

Account number of the other party -- Kontonummer; field 31 in field :86:

const char* HBCI_StandingOrder_otherBankCode (  const HBCI_StandingOrder *    t ) 
 

Institute code (BLZ); field 30 in field :86:

int HBCI_StandingOrder_otherCountryCode (  const HBCI_StandingOrder *    t ) 
 

Country code (BLZ) of the other party's institute -- not in MT940/field :86:

const list_string* HBCI_StandingOrder_otherName (  const HBCI_StandingOrder *    t ) 
 

Name of the other party -- fields 32 and 33 in field :86:

const char* HBCI_StandingOrder_otherSuffix (  const HBCI_StandingOrder *    t ) 
 

If the account of the other party has subaccounts which are distinguished by different suffixes, then this is that suffix of the other party. Otherwise it's empty. -- *not* in MT940 / field :86:

const char* HBCI_StandingOrder_ourAccountId (  const HBCI_StandingOrder *    t ) 
 

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

const char* HBCI_StandingOrder_ourBankCode (  const HBCI_StandingOrder *    t ) 
 

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

The const char* pointer of this and all the following functions points to the c_str() result of the underlying std::string object. It is therefore valid as long as the StandingOrder object wasn't changed, and it should NOT be free'd by the caller.

int HBCI_StandingOrder_ourCountryCode (  const HBCI_StandingOrder *    t ) 
 

country code of your institute -- not in MT940.

const char* HBCI_StandingOrder_ourSuffix (  const HBCI_StandingOrder *    t ) 
 

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

int HBCI_StandingOrder_period (  const HBCI_StandingOrder *    h ) 
 

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

void HBCI_StandingOrder_setCycle (  HBCI_StandingOrder *    h,
int    v
) 
 

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 (  HBCI_StandingOrder *    h,
int    d
) 
 

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 (  HBCI_StandingOrder *    h,
const HBCI_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 (  HBCI_StandingOrder *    h,
const HBCI_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 (  HBCI_StandingOrder *    h,
const char *    s
) 
 

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

void HBCI_StandingOrder_setLastExecutionDate (  HBCI_StandingOrder *    h,
const HBCI_Date *    ex
) 
 

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

void HBCI_StandingOrder_setOtherAccountId (  HBCI_StandingOrder *    t,
const char *    s
) 
 

void HBCI_StandingOrder_setOtherBankCode (  HBCI_StandingOrder *    t,
const char *    s
) 
 

void HBCI_StandingOrder_setOtherCountryCode (  HBCI_StandingOrder *    t,
int    i
) 
 

void HBCI_StandingOrder_setOtherSuffix (  HBCI_StandingOrder *    t,
const char *    id
) 
 

void HBCI_StandingOrder_setOurAccountId (  HBCI_StandingOrder *    t,
const char *    id
) 
 

void HBCI_StandingOrder_setOurBankCode (  HBCI_StandingOrder *    t,
const char *    code
) 
 

void HBCI_StandingOrder_setOurCountryCode (  HBCI_StandingOrder *    t,
int    i
) 
 

void HBCI_StandingOrder_setOurSuffix (  HBCI_StandingOrder *    t,
const char *    id
) 
 

void HBCI_StandingOrder_setPeriod (  HBCI_StandingOrder *    h,
int    c
) 
 

Set the time-unit for cycle() to week or month

Note: It must be consistent with firstExecutionDate() and execDay()

void HBCI_StandingOrder_setTransactionCode (  HBCI_StandingOrder *    t,
int    c
) 
 

Set the type of order. Should be 52 in most cases

void HBCI_StandingOrder_setValue (  HBCI_StandingOrder *    t,
const HBCI_Value *    v
) 
 

Parameters:
t  The object to perform this action on.
v  the value. a deep copy of its data will be stored, so the pointer lifecycle doesn't affect this transaction.

int HBCI_StandingOrder_transactionCode (  const HBCI_StandingOrder *    t ) 
 

Returns a code that identifies the type of order This should be 52 in most cases

const HBCI_Value* HBCI_StandingOrder_value (  const HBCI_StandingOrder *    t ) 
 

The value of this transaction in the account's currency. -- Betrag in :61:

list_HBCI_StO_iter* list_HBCI_StO_begin (  const list_HBCI_StO *    l ) 
 

void list_HBCI_StO_delete (  list_HBCI_StO *    l ) 
 

list_HBCI_StO_iter* list_HBCI_StO_end (  const list_HBCI_StO *    l ) 
 

void* list_HBCI_StO_foreach (  const list_HBCI_StO *    list,
list_HBCI_StO_cb    func,
void *    user_data
) 
 

Traverses the list, calling the callback function 'func' on each list element. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL.

Parameters:
list  The list to traverse.
func  The function to be called with each list element.
user_data  A pointer passed on to the function 'func'.
Returns :
The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL.
Author:
Christian Stimming <stimming@tuhh.de>

void list_HBCI_StO_iter_delete (  list_HBCI_StO_iter *    l ) 
 

int list_HBCI_StO_iter_equal (  const list_HBCI_StO_iter *    l1,
const list_HBCI_StO_iter *    l2
) 
 

const HBCI_StandingOrder* list_HBCI_StO_iter_get (  const list_HBCI_StO_iter *    l ) 
 

void list_HBCI_StO_iter_next (  list_HBCI_StO_iter *    l ) 
 

int list_HBCI_StO_size (  const list_HBCI_StO *    l ) 
 

Generated on Mon Jun 23 13:41:08 2003 for openhbci by doxygen1.2.17