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

aqbanking/job.h File Reference

#include <gwenhywfar/misc2.h>
#include <gwenhywfar/gwentime.h>
#include <aqbanking/error.h>
#include <aqbanking/account.h>

Go to the source code of this file.

Constructing, Destroying, Attaching

Actually this group does not contain a constructor since you never create an AB_JOB directly. You rather create a derived job (e.g. by using AB_JobGetBalance_new).

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

Informational Functions

GWEN_TYPE_UINT32 AB_Job_GetJobId (const AB_JOB *j)
const char * AB_Job_GetCreatedBy (const AB_JOB *j)
GWEN_DB_NODE * AB_Job_GetAppData (AB_JOB *j)
int AB_Job_CheckAvailability (AB_JOB *j)
AB_JOB_STATUS AB_Job_GetStatus (const AB_JOB *j)
const GWEN_TIME * AB_Job_GetLastStatusChange (const AB_JOB *j)
AB_JOB_TYPE AB_Job_GetType (const AB_JOB *j)
AB_ACCOUNTAB_Job_GetAccount (const AB_JOB *j)
const char * AB_Job_GetResultText (const AB_JOB *j)
const char * AB_Job_GetUsedTan (const AB_JOB *j)

Helper Functions

const char * AB_Job_Status2Char (AB_JOB_STATUS i)
AB_JOB_STATUS AB_Job_Char2Status (const char *s)
const char * AB_Job_Type2Char (AB_JOB_TYPE i)
AB_JOB_TYPE AB_Job_Char2Type (const char *s)

Logging Functions

void AB_Job_Log (AB_JOB *j, AB_BANKING_LOGLEVEL ll, const char *who, const char *txt)
GWEN_STRINGLIST * AB_Job_GetLogs (const AB_JOB *j)

Typedefs

typedef AB_JOB AB_JOB

Enumerations

enum  AB_JOB_STATUS {
  AB_Job_StatusNew = 0, AB_Job_StatusUpdated, AB_Job_StatusEnqueued, AB_Job_StatusSent,
  AB_Job_StatusPending, AB_Job_StatusFinished, AB_Job_StatusError, AB_Job_StatusDeferred,
  AB_Job_StatusUnknown = 999
}
enum  AB_JOB_TYPE {
  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
}

Functions

void AB_Job_List2_FreeAll (AB_JOB_LIST2 *jl)


Function Documentation

void AB_Job_Attach AB_JOB j  ) 
 

AB_JOB_STATUS AB_Job_Char2Status const char *  s  ) 
 

Transforms the given string into a job status code.

AB_JOB_TYPE AB_Job_Char2Type const char *  s  ) 
 

Transforms the given string into a job type.

int AB_Job_CheckAvailability AB_JOB j  ) 
 

Not all jobs have to be supported by every backend. The application needs to know whether a job actually is supported, and this is done by calling this function. It returns the error code (see (Error Codes)) returned by the backend when asked to check for this job.

void AB_Job_free AB_JOB j  ) 
 

AB_ACCOUNT* AB_Job_GetAccount const AB_JOB j  ) 
 

Every job is linked to a single account to operate on.

GWEN_DB_NODE* AB_Job_GetAppData AB_JOB j  ) 
 

Returns a GWEN_DB_NODE which can be used to store/retrieve data for the currently running application. The group returned MUST NOT be freed ! AqBanking is able to separate and store the data for every application.

const char* AB_Job_GetCreatedBy const AB_JOB j  ) 
 

Returns the name of the application which created this job.

GWEN_TYPE_UINT32 AB_Job_GetJobId const AB_JOB j  ) 
 

Every created job gets an unique id. This allows any application to identify a specific job. However, unique ids are assigned when they get enqueued (i.e. by calling AB_Banking_EnqueueJob).

const GWEN_TIME* AB_Job_GetLastStatusChange const AB_JOB j  ) 
 

Returns the time when the status of this job changed last.

GWEN_STRINGLIST* AB_Job_GetLogs const AB_JOB j  ) 
 

const char* AB_Job_GetResultText const AB_JOB j  ) 
 

Returns a text result provided by the backend upon execution of this job. This should only be presented to the user when there is no other way to determine the result (e.g. no log etc).

AB_JOB_STATUS AB_Job_GetStatus const AB_JOB j  ) 
 

Returns the status of this job.

AB_JOB_TYPE AB_Job_GetType const AB_JOB j  ) 
 

Returns the job type.

const char* AB_Job_GetUsedTan const AB_JOB j  ) 
 

void AB_Job_Log AB_JOB j,
AB_BANKING_LOGLEVEL  ll,
const char *  who,
const char *  txt
 

const char* AB_Job_Status2Char AB_JOB_STATUS  i  ) 
 

Transforms the given status code into a string.

const char* AB_Job_Type2Char AB_JOB_TYPE  i  ) 
 

Transforms the given job type into a string.


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