job.h

Go to the documentation of this file.

/***************************************************************************
 $RCSfile$
 -------------------
 cvs         : $Id$
 begin       : Mon Mar 01 2004
 copyright   : (C) 2004 by Martin Preuss
 email       : martin@libchipcard.de

 ***************************************************************************
 * This file is part of the project "AqBanking".                           *
 * Please see toplevel file COPYING of that project for license details.   *
 ***************************************************************************/


#ifndef AQBANKING_JOB_H
#define AQBANKING_JOB_H

#include <gwenhywfar/list2.h>
#include <gwenhywfar/gwentime.h>
#include <gwenhywfar/logger.h>
#include <aqbanking/error.h> /* for AQBANKING_API */

#ifdef __cplusplus
extern "C" {
#endif


typedef struct AB_JOB AB_JOB;

GWEN_LIST2_FUNCTION_LIB_DEFS(AB_JOB, AB_Job, AQBANKING_API)


AQBANKING_API
void AB_Job_List2_FreeAll(AB_JOB_LIST2 *jl);

AQBANKING_API
void AB_Job_List2_ClearAll(AB_JOB_LIST2 *jl);

typedef enum {
  AB_Job_StatusNew=0,
  AB_Job_StatusUpdated,
  AB_Job_StatusEnqueued,
  AB_Job_StatusSent,
  AB_Job_StatusPending,
  AB_Job_StatusFinished,
  AB_Job_StatusError,
  AB_Job_StatusUnknown=999
} AB_JOB_STATUS;


typedef enum {
  AB_Job_TypeUnknown=0,
  AB_Job_TypeGetBalance,
  AB_Job_TypeGetTransactions,
  AB_Job_TypeTransfer,
  AB_Job_TypeDebitNote,
  AB_Job_TypeEuTransfer,
  AB_Job_TypeGetStandingOrders,
  AB_Job_TypeGetDatedTransfers,
  AB_Job_TypeCreateStandingOrder,
  AB_Job_TypeModifyStandingOrder,
  AB_Job_TypeDeleteStandingOrder,
  AB_Job_TypeCreateDatedTransfer,
  AB_Job_TypeModifyDatedTransfer,
  AB_Job_TypeDeleteDatedTransfer,
  /* internal transfer between two accounts at the same bank */
  AB_Job_TypeInternalTransfer,
  AB_Job_TypeLoadCellPhone,
  AB_Job_TypeSepaTransfer,
  AB_Job_TypeSepaDebitNote,

  AB_Job_TypeSepaCreateStandingOrder,
  AB_Job_TypeSepaModifyStandingOrder,
  AB_Job_TypeSepaDeleteStandingOrder,

  AB_Job_TypeSepaFlashDebitNote,

  AB_Job_TypeSepaGetStandingOrders,

} AB_JOB_TYPE;



#ifdef __cplusplus
}
#endif


#include <aqbanking/account.h>
#include <aqbanking/transaction.h>


#ifdef __cplusplus
extern "C" {
#endif

AQBANKING_API
void AB_Job_free(AB_JOB *j);
AQBANKING_API
void AB_Job_Attach(AB_JOB *j);

AQBANKING_API
uint32_t AB_Job_GetJobId(const AB_JOB *j);

AQBANKING_API
const char *AB_Job_GetCreatedBy(const AB_JOB *j);


AQBANKING_API 
GWEN_DB_NODE *AB_Job_GetAppData(AB_JOB *j);


AQBANKING_API
int AB_Job_CheckAvailability(AB_JOB *j);

AQBANKING_API
AB_JOB_STATUS AB_Job_GetStatus(const AB_JOB *j);


AQBANKING_API
void  AB_Job_SetStatus(AB_JOB *j, AB_JOB_STATUS st);

AQBANKING_API
const GWEN_TIME *AB_Job_GetLastStatusChange(const AB_JOB *j);

AQBANKING_API
AB_JOB_TYPE AB_Job_GetType(const AB_JOB *j);

AQBANKING_API
AB_ACCOUNT *AB_Job_GetAccount(const AB_JOB *j);

AQBANKING_API
const char *AB_Job_GetResultText(const AB_JOB *j);

AQBANKING_API
const char *AB_Job_GetUsedTan(const AB_JOB *j);

AQBANKING_API
int AB_Job_SetTransaction(AB_JOB *j, const AB_TRANSACTION *t);

AQBANKING_API
AB_TRANSACTION *AB_Job_GetTransaction(const AB_JOB *j);

AQBANKING_API
const AB_TRANSACTION_LIMITS *AB_Job_GetFieldLimits(AB_JOB *j);

AQBANKING_API
void AB_Job_SetFieldLimits(AB_JOB *j, AB_TRANSACTION_LIMITS *limits);


AQBANKING_API
const char *AB_Job_Status2Char(AB_JOB_STATUS i);

AQBANKING_API
AB_JOB_STATUS AB_Job_Char2Status(const char *s);

AQBANKING_API
const char *AB_Job_Type2Char(AB_JOB_TYPE i);

AQBANKING_API
AB_JOB_TYPE AB_Job_Char2Type(const char *s);

AQBANKING_API
const char *AB_Job_Type2LocalChar(AB_JOB_TYPE i);

AQBANKING_API
GWEN_TIME *AB_Job_DateFromDb(GWEN_DB_NODE *db, const char *name);

AQBANKING_API
void AB_Job_DateOnlyToDb(const GWEN_TIME *ti,
                         GWEN_DB_NODE *db,
                         const char *name);

AQBANKING_API
GWEN_TIME *AB_Job_DateOnlyFromDb(GWEN_DB_NODE *db, const char *name);

AQBANKING_API
void AB_Job_DateToDb(const GWEN_TIME *ti, GWEN_DB_NODE *db, const char *name);


AQBANKING_API
void AB_Job_Log(AB_JOB *j,
                GWEN_LOGGER_LEVEL ll,
                const char *who,
                const char *txt);

AQBANKING_API
GWEN_STRINGLIST *AB_Job_GetLogs(const AB_JOB *j);

 /* defgroup */


#ifdef __cplusplus
}
#endif


#endif /* AQBANKING_JOB_H */