job.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  $RCSfile: job.h,v $
00003  -------------------
00004  cvs         : $Id: job.h,v 1.22 2005/09/09 13:52:05 aquamaniac Exp $
00005  begin       : Mon Mar 01 2004
00006  copyright   : (C) 2004 by Martin Preuss
00007  email       : martin@libchipcard.de
00008 
00009  ***************************************************************************
00010  *          Please see toplevel file COPYING for license details           *
00011  ***************************************************************************/
00012 
00013 
00014 #ifndef AQBANKING_JOB_H
00015 #define AQBANKING_JOB_H
00016 
00017 #include <gwenhywfar/misc2.h>
00018 #include <gwenhywfar/gwentime.h>
00019 #include <aqbanking/error.h> /* for AQBANKING_API */
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00032 
00033 typedef struct AB_JOB AB_JOB;
00034 
00035 GWEN_LIST2_FUNCTION_LIB_DEFS(AB_JOB, AB_Job, AQBANKING_API)
00036 
00037 
00038 AQBANKING_API
00039 void AB_Job_List2_FreeAll(AB_JOB_LIST2 *jl);
00040 
00041 
00043 typedef enum {
00045   AB_Job_StatusNew=0,
00047   AB_Job_StatusUpdated,
00051   AB_Job_StatusEnqueued,
00053   AB_Job_StatusSent,
00060   AB_Job_StatusPending,
00064   AB_Job_StatusFinished,
00068   AB_Job_StatusError,
00071   AB_Job_StatusDeferred,
00073   AB_Job_StatusUnknown=999
00074 } AB_JOB_STATUS;
00075 
00076 
00078 typedef enum {
00080   AB_Job_TypeUnknown=0,
00082   AB_Job_TypeGetBalance,
00084   AB_Job_TypeGetTransactions,
00086   AB_Job_TypeTransfer,
00088   AB_Job_TypeDebitNote,
00090   AB_Job_TypeEuTransfer,
00092   AB_Job_TypeGetStandingOrders,
00094   AB_Job_TypeGetDatedTransfers,
00095   /* creates a new standing order */
00096   AB_Job_TypeCreateStandingOrder,
00097   /* modifies an existing standing order */
00098   AB_Job_TypeModifyStandingOrder,
00099   /* deletes an existing standing order */
00100   AB_Job_TypeDeleteStandingOrder,
00101   /* creates a new dated transfer */
00102   AB_Job_TypeCreateDatedTransfer,
00103   /* modifies an existing dated transfer */
00104   AB_Job_TypeModifyDatedTransfer,
00105   /* deletes an existing dated transfer */
00106   AB_Job_TypeDeleteDatedTransfer,
00107   /* internal transfer between two accounts at the same bank */
00108   AB_Job_TypeInternalTransfer
00109 } AB_JOB_TYPE;
00110 
00111 
00112 
00113 #ifdef __cplusplus
00114 }
00115 #endif
00116 
00117 
00118 #include <aqbanking/account.h>
00119 
00120 
00121 #ifdef __cplusplus
00122 extern "C" {
00123 #endif
00124 
00132 AQBANKING_API
00133 void AB_Job_free(AB_JOB *j);
00134 AQBANKING_API
00135 void AB_Job_Attach(AB_JOB *j);
00143 
00149 AQBANKING_API
00150 GWEN_TYPE_UINT32 AB_Job_GetJobId(const AB_JOB *j);
00151 
00155 AQBANKING_API
00156 const char *AB_Job_GetCreatedBy(const AB_JOB *j);
00157 
00158 
00165 AQBANKING_API 
00166 GWEN_DB_NODE *AB_Job_GetAppData(AB_JOB *j);
00167 
00168 
00175 AQBANKING_API
00176 int AB_Job_CheckAvailability(AB_JOB *j);
00177 
00181 AQBANKING_API
00182 AB_JOB_STATUS AB_Job_GetStatus(const AB_JOB *j);
00183 
00187 AQBANKING_API
00188 const GWEN_TIME *AB_Job_GetLastStatusChange(const AB_JOB *j);
00189 
00193 AQBANKING_API
00194 AB_JOB_TYPE AB_Job_GetType(const AB_JOB *j);
00195 
00199 AQBANKING_API
00200 AB_ACCOUNT *AB_Job_GetAccount(const AB_JOB *j);
00201 
00207 AQBANKING_API
00208 const char *AB_Job_GetResultText(const AB_JOB *j);
00209 
00210 AQBANKING_API
00211 const char *AB_Job_GetUsedTan(const AB_JOB *j);
00219 
00223 AQBANKING_API
00224 const char *AB_Job_Status2Char(AB_JOB_STATUS i);
00225 
00229 AQBANKING_API
00230 AB_JOB_STATUS AB_Job_Char2Status(const char *s);
00231 
00235 AQBANKING_API
00236 const char *AB_Job_Type2Char(AB_JOB_TYPE i);
00237 
00241 AQBANKING_API
00242 AB_JOB_TYPE AB_Job_Char2Type(const char *s);
00251 AQBANKING_API
00252 void AB_Job_Log(AB_JOB *j,
00253                 AB_BANKING_LOGLEVEL ll,
00254                 const char *who,
00255                 const char *txt);
00256 
00257 AQBANKING_API
00258 GWEN_STRINGLIST *AB_Job_GetLogs(const AB_JOB *j);
00259 
00263  /* defgroup */
00264 
00265 
00266 #ifdef __cplusplus
00267 }
00268 #endif
00269 
00270 
00271 #endif /* AQBANKING_JOB_H */
00272 
00273 
00274 
00275 

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