job.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  $RCSfile$
00003  -------------------
00004  cvs         : $Id: job.h 953 2006-02-24 03:07:59Z aquamaniac $
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/list2.h>
00018 #include <gwenhywfar/gwentime.h>
00019 #include <aqbanking/error.h> /* for AQBANKING_API */
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00101 
00102 typedef struct AB_JOB AB_JOB;
00103 
00104 GWEN_LIST2_FUNCTION_LIB_DEFS(AB_JOB, AB_Job, AQBANKING_API)
00105 
00106 
00107 AQBANKING_API
00108 void AB_Job_List2_FreeAll(AB_JOB_LIST2 *jl);
00109 
00110 
00112 typedef enum {
00114   AB_Job_StatusNew=0,
00116   AB_Job_StatusUpdated,
00120   AB_Job_StatusEnqueued,
00122   AB_Job_StatusSent,
00129   AB_Job_StatusPending,
00133   AB_Job_StatusFinished,
00138   AB_Job_StatusError,
00140   AB_Job_StatusUnknown=999
00141 } AB_JOB_STATUS;
00142 
00143 
00145 typedef enum {
00147   AB_Job_TypeUnknown=0,
00149   AB_Job_TypeGetBalance,
00151   AB_Job_TypeGetTransactions,
00153   AB_Job_TypeTransfer,
00155   AB_Job_TypeDebitNote,
00157   AB_Job_TypeEuTransfer,
00159   AB_Job_TypeGetStandingOrders,
00161   AB_Job_TypeGetDatedTransfers,
00162   /* creates a new standing order */
00163   AB_Job_TypeCreateStandingOrder,
00164   /* modifies an existing standing order */
00165   AB_Job_TypeModifyStandingOrder,
00166   /* deletes an existing standing order */
00167   AB_Job_TypeDeleteStandingOrder,
00168   /* creates a new dated transfer */
00169   AB_Job_TypeCreateDatedTransfer,
00170   /* modifies an existing dated transfer */
00171   AB_Job_TypeModifyDatedTransfer,
00172   /* deletes an existing dated transfer */
00173   AB_Job_TypeDeleteDatedTransfer,
00174   /* internal transfer between two accounts at the same bank */
00175   AB_Job_TypeInternalTransfer
00176 } AB_JOB_TYPE;
00177 
00178 
00179 
00180 #ifdef __cplusplus
00181 }
00182 #endif
00183 
00184 
00185 #include <aqbanking/account.h>
00186 
00187 
00188 #ifdef __cplusplus
00189 extern "C" {
00190 #endif
00191 
00199 AQBANKING_API
00200 void AB_Job_free(AB_JOB *j);
00201 AQBANKING_API
00202 void AB_Job_Attach(AB_JOB *j);
00210 
00216 AQBANKING_API
00217 GWEN_TYPE_UINT32 AB_Job_GetJobId(const AB_JOB *j);
00218 
00222 AQBANKING_API
00223 const char *AB_Job_GetCreatedBy(const AB_JOB *j);
00224 
00225 
00232 AQBANKING_API 
00233 GWEN_DB_NODE *AB_Job_GetAppData(AB_JOB *j);
00234 
00235 
00242 AQBANKING_API
00243 int AB_Job_CheckAvailability(AB_JOB *j);
00244 
00248 AQBANKING_API
00249 AB_JOB_STATUS AB_Job_GetStatus(const AB_JOB *j);
00250 
00254 AQBANKING_API
00255 const GWEN_TIME *AB_Job_GetLastStatusChange(const AB_JOB *j);
00256 
00260 AQBANKING_API
00261 AB_JOB_TYPE AB_Job_GetType(const AB_JOB *j);
00262 
00266 AQBANKING_API
00267 AB_ACCOUNT *AB_Job_GetAccount(const AB_JOB *j);
00268 
00274 AQBANKING_API
00275 const char *AB_Job_GetResultText(const AB_JOB *j);
00276 
00277 AQBANKING_API
00278 const char *AB_Job_GetUsedTan(const AB_JOB *j);
00286 
00290 AQBANKING_API
00291 const char *AB_Job_Status2Char(AB_JOB_STATUS i);
00292 
00296 AQBANKING_API
00297 AB_JOB_STATUS AB_Job_Char2Status(const char *s);
00298 
00302 AQBANKING_API
00303 const char *AB_Job_Type2Char(AB_JOB_TYPE i);
00304 
00308 AQBANKING_API
00309 AB_JOB_TYPE AB_Job_Char2Type(const char *s);
00310 
00315 AQBANKING_API
00316 const char *AB_Job_Type2LocalChar(AB_JOB_TYPE i);
00317 
00330 AQBANKING_API
00331 void AB_Job_Log(AB_JOB *j,
00332                 AB_BANKING_LOGLEVEL ll,
00333                 const char *who,
00334                 const char *txt);
00335 
00342 AQBANKING_API
00343 GWEN_STRINGLIST *AB_Job_GetLogs(const AB_JOB *j);
00344 
00348  /* defgroup */
00349 
00350 
00351 #ifdef __cplusplus
00352 }
00353 #endif
00354 
00355 
00356 #endif /* AQBANKING_JOB_H */
00357 
00358 
00359 
00360 

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