Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

aqbanking/job.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  $RCSfile: job.h,v $
00003  -------------------
00004  cvs         : $Id: job.h,v 1.21 2005/08/27 06:29:50 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 } AB_JOB_TYPE;
00108 
00109 
00110 
00111 #ifdef __cplusplus
00112 }
00113 #endif
00114 
00115 
00116 #include <aqbanking/account.h>
00117 
00118 
00119 #ifdef __cplusplus
00120 extern "C" {
00121 #endif
00122 
00130 AQBANKING_API
00131 void AB_Job_free(AB_JOB *j);
00132 AQBANKING_API
00133 void AB_Job_Attach(AB_JOB *j);
00141 
00147 AQBANKING_API
00148 GWEN_TYPE_UINT32 AB_Job_GetJobId(const AB_JOB *j);
00149 
00153 AQBANKING_API
00154 const char *AB_Job_GetCreatedBy(const AB_JOB *j);
00155 
00156 
00163 AQBANKING_API 
00164 GWEN_DB_NODE *AB_Job_GetAppData(AB_JOB *j);
00165 
00166 
00173 AQBANKING_API
00174 int AB_Job_CheckAvailability(AB_JOB *j);
00175 
00179 AQBANKING_API
00180 AB_JOB_STATUS AB_Job_GetStatus(const AB_JOB *j);
00181 
00185 AQBANKING_API
00186 const GWEN_TIME *AB_Job_GetLastStatusChange(const AB_JOB *j);
00187 
00191 AQBANKING_API
00192 AB_JOB_TYPE AB_Job_GetType(const AB_JOB *j);
00193 
00197 AQBANKING_API
00198 AB_ACCOUNT *AB_Job_GetAccount(const AB_JOB *j);
00199 
00205 AQBANKING_API
00206 const char *AB_Job_GetResultText(const AB_JOB *j);
00207 
00208 AQBANKING_API
00209 const char *AB_Job_GetUsedTan(const AB_JOB *j);
00217 
00221 AQBANKING_API
00222 const char *AB_Job_Status2Char(AB_JOB_STATUS i);
00223 
00227 AQBANKING_API
00228 AB_JOB_STATUS AB_Job_Char2Status(const char *s);
00229 
00233 AQBANKING_API
00234 const char *AB_Job_Type2Char(AB_JOB_TYPE i);
00235 
00239 AQBANKING_API
00240 AB_JOB_TYPE AB_Job_Char2Type(const char *s);
00249 AQBANKING_API
00250 void AB_Job_Log(AB_JOB *j,
00251                 AB_BANKING_LOGLEVEL ll,
00252                 const char *who,
00253                 const char *txt);
00254 
00255 AQBANKING_API
00256 GWEN_STRINGLIST *AB_Job_GetLogs(const AB_JOB *j);
00257 
00261  /* defgroup */
00262 
00263 
00264 #ifdef __cplusplus
00265 }
00266 #endif
00267 
00268 
00269 #endif /* AQBANKING_JOB_H */
00270 
00271 
00272 
00273 

Generated on Thu Oct 6 14:49:08 2005 for aqbanking by  doxygen 1.4.4