Im- and Exporter Account Info
[Generic Im- and Exporter]


Detailed Description

Such a structure contains the list of imported/to be exported transactions for a given account.


Transactions

typedef const AB_TRANSACTION *( AB_TRANSACTION_CONSTLIST2_FOREACH )(const AB_TRANSACTION *element, void *user_data)
void AB_ImExporterAccountInfo_AddTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_TransactionsForEach (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION_CONSTLIST2_FOREACH func, void *user_data)

Constructor, Destructor, Copy

AB_IMEXPORTER_ACCOUNTINFOAB_ImExporterAccountInfo_new ()
void AB_ImExporterAccountInfo_free (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_IMEXPORTER_ACCOUNTINFOAB_ImExporterAccountInfo_dup (const AB_IMEXPORTER_ACCOUNTINFO *oldiea)

Informational Functions

const char * AB_ImExporterAccountInfo_GetBankCode (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetBankCode (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetBankName (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetBankName (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetAccountNumber (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetAccountNumber (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetAccountName (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetAccountName (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetIban (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetIban (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetCurrency (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetCurrency (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetOwner (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetOwner (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
AB_ACCOUNT_TYPE AB_ImExporterAccountInfo_GetType (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetType (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_ACCOUNT_TYPE t)
const char * AB_ImExporterAccountInfo_GetDescription (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetDescription (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)

Account Status

void AB_ImExporterAccountInfo_AddAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_ACCOUNT_STATUS *st)
AB_ACCOUNT_STATUSAB_ImExporterAccountInfo_GetFirstAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_ACCOUNT_STATUSAB_ImExporterAccountInfo_GetNextAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea)

Standing Orders

void AB_ImExporterAccountInfo_AddStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea)

Transfers

void AB_ImExporterAccountInfo_AddTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)

Dated Transfers

void AB_ImExporterAccountInfo_AddDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)

Noted Transactions

void AB_ImExporterAccountInfo_AddNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)


Typedef Documentation

typedef const AB_TRANSACTION*( AB_TRANSACTION_CONSTLIST2_FOREACH)(const AB_TRANSACTION *element, void *user_data)

Callback function type for AB_ImExporterAccountInfo_TransactionsForEach()

(As soon as transaction.h declares this type itself, this declaration can be removed. Currently transaction.h only declares the LIST2 but not the CONSTLIST2, so we add this declaration here. If transaction.h declares the CONSTLIST2 as well, it wouldn't harm because this typedef is exactly identical to the one from the GWEN_CONSTLIST2_FUNCTION_LIB_DEFS macro.)

Definition at line 443 of file imexporter.h.


Function Documentation

void AB_ImExporterAccountInfo_AddAccountStatus ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_ACCOUNT_STATUS st 
)

Takes over ownership of the given account status.

void AB_ImExporterAccountInfo_AddDatedTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION t 
)

Takes over ownership of the given dated transfer.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

void AB_ImExporterAccountInfo_AddNotedTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION t 
)

Takes over ownership of the given noted transfer.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

void AB_ImExporterAccountInfo_AddStandingOrder ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION t 
)

Takes over ownership of the given standing order.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

void AB_ImExporterAccountInfo_AddTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION t 
)

Takes over ownership of the given transaction.

void AB_ImExporterAccountInfo_AddTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION t 
)

Takes over ownership of the given transfer.

The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterAccountInfo_dup ( const AB_IMEXPORTER_ACCOUNTINFO oldiea  ) 

Returns a copy of the given account info. Please note that only the data is copied, internal pointers for AB_ImExporterAccountInfo_GetNextTransaction et al are reset in the copy.

void AB_ImExporterAccountInfo_free ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

const char* AB_ImExporterAccountInfo_GetAccountName ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Account name. Used when importing data, not used when exporting.

const char* AB_ImExporterAccountInfo_GetAccountNumber ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Account number. Used when importing data, not used when exporting.

const char* AB_ImExporterAccountInfo_GetBankCode ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Bank code of the institute the account is at.

const char* AB_ImExporterAccountInfo_GetBankName ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Bank name of the institute the account is at.

const char* AB_ImExporterAccountInfo_GetCurrency ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Account currency

const char* AB_ImExporterAccountInfo_GetDescription ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

AB_ACCOUNT_STATUS* AB_ImExporterAccountInfo_GetFirstAccountStatus ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first account status stored within the context and removes it. The caller becomes the new owner of the account status returned (if any) which makes him/her responsible for freeing it using AB_AccountStatus_free.

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetFirstDatedTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first dated transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetFirstNotedTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first noted transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetFirstStandingOrder ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first standing order stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetFirstTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first transaction stored within the context. The context remains the owner of the object returned.

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetFirstTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the first transfer stored within the context. The context remains the owner of the object returned. The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const char* AB_ImExporterAccountInfo_GetIban ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

IBAN.

AB_ACCOUNT_STATUS* AB_ImExporterAccountInfo_GetNextAccountStatus ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next account status stored within the context and removes it The caller becomes the new owner of the account status returned (if any) which makes him/her responsible for freeing it using AB_AccountStatus_free.

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetNextDatedTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next dated transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetNextNotedTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next noted transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetNextStandingOrder ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next standing order stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetNextTransaction ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next transaction stored within the context. The context remains the owner of the object returned.

const AB_TRANSACTION* AB_ImExporterAccountInfo_GetNextTransfer ( AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Returns the next transfer stored within the context. The context remains the owner of the object returned. The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

const char* AB_ImExporterAccountInfo_GetOwner ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

Name of the account' owner. Used when importing data, not used when exporting.

AB_ACCOUNT_TYPE AB_ImExporterAccountInfo_GetType ( const AB_IMEXPORTER_ACCOUNTINFO iea  ) 

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterAccountInfo_new (  ) 

void AB_ImExporterAccountInfo_SetAccountName ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetAccountNumber ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetBankCode ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetBankName ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetCurrency ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetDescription ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetIban ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetOwner ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

void AB_ImExporterAccountInfo_SetType ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_ACCOUNT_TYPE  t 
)

const AB_TRANSACTION* AB_ImExporterAccountInfo_TransactionsForEach ( AB_IMEXPORTER_ACCOUNTINFO iea,
AB_TRANSACTION_CONSTLIST2_FOREACH  func,
void *  user_data 
)

Traverses the list of Transactions in this AccountInfo, 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.

Note: It is not totally clear to me whether this function might interfere with AB_ImExporterAccountInfo_GetFirstTransaction() / AB_ImExporterAccountInfo_GetNextTransaction() . To be on the safe side, you should probably traverse the transaction list only *either* by those mentioned two functions *or* by this ForEach function, but you should probably not mix the access through this two methods. (This doubt be changed in future versions.)

Available since aqbanking-1.9.7.

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.


Generated on Sun Apr 29 17:23:05 2007 for aqbanking by  doxygen 1.5.1