job.h File Reference

#include <gwenhywfar/inherit.h>
#include <aqhbci/result.h>
#include <stdio.h>
#include <gwenhywfar/misc.h>
#include <gwenhywfar/misc2.h>
#include <gwenhywfar/db.h>
#include <aqhbci/customer.h>
#include <aqbanking/job.h>

Go to the source code of this file.

Prototypes For Virtual Functions

typedef int(* AH_JOB_PROCESS_FN )(AH_JOB *j)
typedef int(* AH_JOB_COMMIT_FN )(AH_JOB *j)
typedef int(* AH_JOB_EXCHANGE_FN )(AH_JOB *j, AB_JOB *bj, AH_JOB_EXCHANGE_MODE m)
typedef int(* AH_JOB_NEXTMSG_FN )(AH_JOB *j)

Constructors, Destructors

void AH_Job_free (AH_JOB *j)
void AH_Job_Attach (AH_JOB *j)

Informational Functions

const char * AH_Job_GetName (const AH_JOB *j)
const char * AH_Job_GetAccountId (const AH_JOB *j)
const char * AH_Job_GetDescription (const AH_JOB *j)
int AH_Job_GetMinSignatures (const AH_JOB *j)
int AH_Job_GetJobsPerMsg (const AH_JOB *j)
AH_CUSTOMERAH_Job_GetCustomer (const AH_JOB *j)
GWEN_DB_NODE * AH_Job_GetParams (const AH_JOB *j)
GWEN_DB_NODE * AH_Job_GetArguments (const AH_JOB *j)
GWEN_DB_NODE * AH_Job_GetResponses (const AH_JOB *j)
unsigned int AH_Job_GetMsgNum (const AH_JOB *j)
const char * AH_Job_GetDialogId (const AH_JOB *j)
AH_JOB_STATUS AH_Job_GetStatus (const AH_JOB *j)
const char * AH_Job_StatusName (AH_JOB_STATUS st)
void AH_Job_AddSigner (AH_JOB *j, const char *s)
int AH_Job_HasWarnings (const AH_JOB *j)
int AH_Job_HasErrors (const AH_JOB *j)
AH_RESULT_LISTAH_Job_GetSegResults (const AH_JOB *j)
AH_RESULT_LISTAH_Job_GetMsgResults (const AH_JOB *j)

Virtual Functions

int AH_Job_Process (AH_JOB *j)
int AH_Job_Commit (AH_JOB *j)
int AH_Job_Exchange (AH_JOB *j, AB_JOB *bj, AH_JOB_EXCHANGE_MODE m)
int AH_Job_CommitSystemData (AH_JOB *j)
int AH_Job_DefaultProcessHandler (AH_JOB *j)
int AH_Job_DefaultCommitHandler (AH_JOB *j)

Setters For Virtual Functions

void AH_Job_SetProcessFn (AH_JOB *j, AH_JOB_PROCESS_FN f)
void AH_Job_SetCommitFn (AH_JOB *j, AH_JOB_COMMIT_FN f)
void AH_Job_SetExchangeFn (AH_JOB *j, AH_JOB_EXCHANGE_FN f)
void AH_Job_SetNextMsgFn (AH_JOB *j, AH_JOB_NEXTMSG_FN f)

Typedefs

typedef AH_JOB AH_JOB

Enumerations

enum  AH_JOB_STATUS {
  AH_JobStatusUnknown = 0, AH_JobStatusToDo, AH_JobStatusEnqueued, AH_JobStatusEncoded,
  AH_JobStatusSent, AH_JobStatusAnswered, AH_JobStatusError, AH_JobStatusAll = 255
}
enum  AH_JOB_EXCHANGE_MODE { AH_Job_ExchangeModeParams = 0, AH_Job_ExchangeModeArgs, AH_Job_ExchangeModeResults }

Functions

 GWEN_INHERIT_FUNCTION_DEFS (AH_JOB)
 GWEN_LIST2_FUNCTION_DEFS (AH_JOB, AH_Job)
void AH_Job_List2_FreeAll (AH_JOB_LIST2 *jl)
void AH_Job_Dump (const AH_JOB *j, FILE *f, unsigned int insert)
const GWEN_STRINGLIST * AH_Job_GetLogs (const AH_JOB *j)


Typedef Documentation

typedef struct AH_JOB AH_JOB
 

Definition at line 25 of file aqhbci/job.h.

typedef int(* AH_JOB_COMMIT_FN)(AH_JOB *j)
 

Definition at line 74 of file aqhbci/job.h.

typedef int(* AH_JOB_EXCHANGE_FN)(AH_JOB *j, AB_JOB *bj, AH_JOB_EXCHANGE_MODE m)
 

Definition at line 75 of file aqhbci/job.h.

typedef int(* AH_JOB_NEXTMSG_FN)(AH_JOB *j)
 

This function is called on multi-message jobs and should return:

  • 0 if it is sure that no message is to follow
  • 1 if there might be more message (will be checked by AqHBCI)
  • any other value (indicating an error)

Definition at line 85 of file aqhbci/job.h.

typedef int(* AH_JOB_PROCESS_FN)(AH_JOB *j)
 

Definition at line 73 of file aqhbci/job.h.


Enumeration Type Documentation

enum AH_JOB_EXCHANGE_MODE
 

Enumerator:
AH_Job_ExchangeModeParams 
AH_Job_ExchangeModeArgs 
AH_Job_ExchangeModeResults 

Definition at line 62 of file aqhbci/job.h.

enum AH_JOB_STATUS
 

Enumerator:
AH_JobStatusUnknown 
AH_JobStatusToDo 
AH_JobStatusEnqueued 
AH_JobStatusEncoded 
AH_JobStatusSent 
AH_JobStatusAnswered 
AH_JobStatusError 
AH_JobStatusAll 

Definition at line 49 of file aqhbci/job.h.


Function Documentation

void AH_Job_AddSigner AH_JOB j,
const char *  s
 

void AH_Job_Attach AH_JOB j  ) 
 

int AH_Job_Commit AH_JOB j  ) 
 

int AH_Job_CommitSystemData AH_JOB j  ) 
 

You can use this from the Commit function of the inheriting class to additionally let the job do some basic stuff (like saving UPD, BPD, messages etc).

int AH_Job_DefaultCommitHandler AH_JOB j  ) 
 

You can use this from the Commit function of the inheriting class. It calls AH_Job_CommitSystemData.

int AH_Job_DefaultProcessHandler AH_JOB j  ) 
 

You can use this from the Process function of the inheriting class to additionally let the job do some basic stuff (like catching UPD, BPD, messages etc).

void AH_Job_Dump const AH_JOB j,
FILE *  f,
unsigned int  insert
 

int AH_Job_Exchange AH_JOB j,
AB_JOB bj,
AH_JOB_EXCHANGE_MODE  m
 

exchanges data between the HBCI job and the banking job

void AH_Job_free AH_JOB j  ) 
 

const char* AH_Job_GetAccountId const AH_JOB j  ) 
 

GWEN_DB_NODE* AH_Job_GetArguments const AH_JOB j  ) 
 

AH_CUSTOMER* AH_Job_GetCustomer const AH_JOB j  ) 
 

const char* AH_Job_GetDescription const AH_JOB j  ) 
 

const char* AH_Job_GetDialogId const AH_JOB j  ) 
 

int AH_Job_GetJobsPerMsg const AH_JOB j  ) 
 

const GWEN_STRINGLIST* AH_Job_GetLogs const AH_JOB j  ) 
 

int AH_Job_GetMinSignatures const AH_JOB j  ) 
 

unsigned int AH_Job_GetMsgNum const AH_JOB j  ) 
 

AH_RESULT_LIST* AH_Job_GetMsgResults const AH_JOB j  ) 
 

const char* AH_Job_GetName const AH_JOB j  ) 
 

GWEN_DB_NODE* AH_Job_GetParams const AH_JOB j  ) 
 

GWEN_DB_NODE* AH_Job_GetResponses const AH_JOB j  ) 
 

AH_RESULT_LIST* AH_Job_GetSegResults const AH_JOB j  ) 
 

AH_JOB_STATUS AH_Job_GetStatus const AH_JOB j  ) 
 

int AH_Job_HasErrors const AH_JOB j  ) 
 

int AH_Job_HasWarnings const AH_JOB j  ) 
 

void AH_Job_List2_FreeAll AH_JOB_LIST2 jl  ) 
 

int AH_Job_Process AH_JOB j  ) 
 

void AH_Job_SetCommitFn AH_JOB j,
AH_JOB_COMMIT_FN  f
 

void AH_Job_SetExchangeFn AH_JOB j,
AH_JOB_EXCHANGE_FN  f
 

void AH_Job_SetNextMsgFn AH_JOB j,
AH_JOB_NEXTMSG_FN  f
 

void AH_Job_SetProcessFn AH_JOB j,
AH_JOB_PROCESS_FN  f
 

const char* AH_Job_StatusName AH_JOB_STATUS  st  ) 
 

GWEN_INHERIT_FUNCTION_DEFS AH_JOB   ) 
 

GWEN_LIST2_FUNCTION_DEFS AH_JOB  ,
AH_Job 
 


Generated on Sat Jan 7 04:22:42 2006 for aqbanking by  doxygen 1.4.6