Definition at line 102 of file aqbanking/job.h.
enum AB_JOB_STATUS |
The status of a job.
Definition at line 112 of file aqbanking/job.h.
enum AB_JOB_TYPE |
The type of the job, which also corresponds to its subclass of AB_JOB.
Definition at line 145 of file aqbanking/job.h.
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 | ) |
Returns a string list containing the logs of the job. Each entry of that string list contains the date/time, loglevel, source and text. The caller becomes the owner of the returned object (if any), please call GWEN_StringList_free on it to avoid memory leaks.
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_List2_FreeAll | ( | AB_JOB_LIST2 * | jl | ) |
This function frees all jobs contained in the given list.
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.
const char* AB_Job_Type2LocalChar | ( | AB_JOB_TYPE | i | ) |
Transforms the given job type into a localized string which can be presented to the user.