AB_Banking Class Reference

A C++ binding for the C module AB_BANKING. More...

#include <banking.h>

Inheritance diagram for AB_Banking:

QBanking

Public Member Functions

 AB_Banking (const char *appname, const char *fname)
virtual ~AB_Banking ()
AB_BANKINGgetCInterface ()
virtual int init ()
virtual int fini ()
int onlineInit ()
int onlineFini ()
AB_PROVIDERgetProvider (const char *name)
const char * getAppName ()
std::list< AB_ACCOUNT * > getAccounts ()
AB_ACCOUNTgetAccount (uint32_t uniqueId)
std::list< AB_USER * > getUsers ()
GWEN_DB_NODE * getAppData ()
GWEN_DB_NODE * getSharedData (const char *name)
int getUserDataDir (GWEN_BUFFER *buf) const
int getAppUserDataDir (GWEN_BUFFER *buf) const
virtual bool importContext (AB_IMEXPORTER_CONTEXT *ctx, uint32_t flags)
Plugin Handling
std::list
< GWEN_PLUGIN_DESCRIPTION * > 
getProviderDescrs ()
std::list
< GWEN_PLUGIN_DESCRIPTION * > 
getWizardDescrs ()
void clearPluginDescrs (std::list< GWEN_PLUGIN_DESCRIPTION * > &l)
std::list< std::string > getActiveProviders ()
std::string findWizard (const char *frontends)
Enqueueing, Dequeueing and Executing Jobs
Enqueued jobs are preserved across shutdowns. As soon as a job has been sent to the appropriate backend it will be removed from the queue. Only those jobs are saved/reloaded which have been enqueued but never presented to the backend. This means after calling AB_Banking_ExecuteQueue only those jobs are still in the queue which have not been processed (e.g. because they belonged to a second backend but the user aborted while the jobs for a first backend were in process).

virtual int executeJobs (AB_JOB_LIST2 *jl, AB_IMEXPORTER_CONTEXT *ctx, uint32_t guiid)

Detailed Description

A C++ binding for the C module AB_BANKING.

This class simply is a C++ binding for the C module AB_BANKING. It redirects C callbacks used by AB_BANKING to virtual functions in this class. It als transforms some return values inconveniant for C++ into STL objects (such as "list<T>").

Author:
Martin Preuss<martin@aquamaniac.de>

Definition at line 43 of file qbanking/banking.h.


Constructor & Destructor Documentation

AB_Banking::AB_Banking ( const char *  appname,
const char *  fname 
)

virtual AB_Banking::~AB_Banking (  )  [virtual]


Member Function Documentation

void AB_Banking::clearPluginDescrs ( std::list< GWEN_PLUGIN_DESCRIPTION * > &  l  ) 

Frees all plugin descriptions whose pointers are stored inside the given list. Please note that this methode renders the list useless, so it should be the last method called on that list before destroying it.

virtual int AB_Banking::executeJobs ( AB_JOB_LIST2 jl,
AB_IMEXPORTER_CONTEXT ctx,
uint32_t  guiid 
) [virtual]

This function sends all jobs in the list to their corresponding backends and allows that backend to process it.

std::string AB_Banking::findWizard ( const char *  frontends  ) 

virtual int AB_Banking::fini (  )  [virtual]

See AB_Banking_Fini

Reimplemented in QBanking.

AB_ACCOUNT* AB_Banking::getAccount ( uint32_t  uniqueId  ) 

This function does an account lookup based on the given unique id. This id is assigned by AqBanking when an account is created. The pointer returned is still owned by AqBanking, so you MUST NOT free it.

std::list<AB_ACCOUNT*> AB_Banking::getAccounts (  ) 

Returns a list of pointers to currently known accounts. Please note that the pointers in this list are still owned by AqBanking, so you MUST NOT free them. However, destroying the list will not free the accounts, so it is safe to do that.

std::list<std::string> AB_Banking::getActiveProviders (  ) 

GWEN_DB_NODE* AB_Banking::getAppData (  ) 

Returns a GWEN_DB_NODE which can be used to store/retrieve data for the currently running application. The group returned MUST NOT be freed. AqBanking is able to separate and store the data for every application.

const char* AB_Banking::getAppName (  ) 

Returns the application name as given to AB_Banking_new.

int AB_Banking::getAppUserDataDir ( GWEN_BUFFER *  buf  )  const

AB_BANKING* AB_Banking::getCInterface (  ) 

AB_PROVIDER* AB_Banking::getProvider ( const char *  name  ) 

Loads a backend with the given name. You can use AB_Banking_GetProviderDescrs to retrieve a list of available backends. Such a backend can then be asked to return an account list.

std::list<GWEN_PLUGIN_DESCRIPTION*> AB_Banking::getProviderDescrs (  ) 

Returns a list of provider descriptions. You must free the contents of the list after using it via clearPluginDescrs() before deleting the list itself.

GWEN_DB_NODE* AB_Banking::getSharedData ( const char *  name  ) 

int AB_Banking::getUserDataDir ( GWEN_BUFFER *  buf  )  const

std::list<AB_USER*> AB_Banking::getUsers (  ) 

Returns a list of pointers to currently known users. Please note that the pointers in this list are still owned by AqBanking, so you MUST NOT free them. However, destroying the list will not free the users, so it is safe to do that.

std::list<GWEN_PLUGIN_DESCRIPTION*> AB_Banking::getWizardDescrs (  ) 

Returns a list of wizard descriptions. You must free the contents of the list after using it via clearPluginDescrs() before deleting the list itself.

virtual bool AB_Banking::importContext ( AB_IMEXPORTER_CONTEXT ctx,
uint32_t  flags 
) [virtual]

Let the application import a given statement context.

Reimplemented in QBanking.

virtual int AB_Banking::init (  )  [virtual]

See AB_Banking_Init

Reimplemented in QBanking.

int AB_Banking::onlineFini (  ) 

int AB_Banking::onlineInit (  ) 


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

Generated on Fri Nov 14 15:30:06 2008 for aqbanking by  doxygen 1.5.7.1