Class HBCIJobResultImpl
- java.lang.Object
-
- org.kapott.hbci.GV_Result.HBCIJobResultImpl
-
- All Implemented Interfaces:
java.io.Serializable
,HBCIJobResult
- Direct Known Subclasses:
AbstractGVRLastSEPA
,GVRAccInfo
,GVRCardList
,GVRDauerEdit
,GVRDauerList
,GVRDauerNew
,GVRFestCondList
,GVRFestList
,GVRInfoList
,GVRInfoOrder
,GVRInstUebSEPA
,GVRKontoauszug
,GVRKUms
,GVRSaldoReq
,GVRStatus
,GVRTANList
,GVRTANMediaList
,GVRTermUeb
,GVRTermUebEdit
,GVRTermUebList
,GVRWPDepotList
,GVRWPDepotUms
,GVRWPStammData
public class HBCIJobResultImpl extends java.lang.Object implements java.io.Serializable, HBCIJobResult
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description HBCIStatus
globStatus
HBCIStatus
jobStatus
-
Constructor Summary
Constructors Constructor Description HBCIJobResultImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDialogId()
Gibt die Dialog-ID zurück, unter der der dazugehörige Job ausgeführt wurde.HBCIStatus
getGlobStatus()
Gibt ein Status-Objekt zurück, welches Status-Informationen zur HBCI-Nachricht selbst enthält, in der die Job-Auftragsdaten übermittelt wurden.java.lang.String
getJobId()
Gibt einen Job-Identifikationsstring zurück, mit dessen Hilfe sich der Job für dasStatusprotokoll
identifizieren lässtHBCIStatus
getJobStatus()
Gibt ein Status-Objekt zurück, welches Status-Informationen über das Auftragssegment enthält, in dem die Job-Auftragsdaten übermittelt wurden.java.lang.String
getMsgNum()
Gibt die Nachrichtennummer innerhalb des Dialoges zurück, in dem der dazugehörige Job ausgeführt wurde.HBCIJob
getParentJob()
HBCIPassport
getPassport()
Gibt das Passport-Objekt zurück, für welches der Job erzeugt wurde.java.util.Properties
getResultData()
Gibt die Job-Antwortdaten im Rohformat zurück.int
getRetNumber()
Gibt zurück, wieviele HBCI-Statuscode (sieheHBCIRetVal
) in den Statusdaten zu diesem Job gespeichert sind.HBCIRetVal
getRetVal(int idx)
Gibt einen bestimmten HBCI-Statuscode aus den Job-Statusinformationen zurück.java.lang.String
getSegNum()
Gibt die Segmentnummer des Segmentes innerhalb der Auftragsnachricht zurück, in welchem die Job-Daten übertragen wurden.boolean
isOK()
Gibt an, ob der Job erfolgreich ausgeführt wurde oder nicht.void
setParentJob(HBCIJobImpl parentJob)
void
storeResult(java.lang.String key, java.lang.String value)
java.lang.String
toString()
-
-
-
Field Detail
-
jobStatus
public HBCIStatus jobStatus
-
globStatus
public HBCIStatus globStatus
-
-
Method Detail
-
setParentJob
public void setParentJob(HBCIJobImpl parentJob)
-
storeResult
public void storeResult(java.lang.String key, java.lang.String value)
-
getRetNumber
public int getRetNumber()
Description copied from interface:HBCIJobResult
Gibt zurück, wieviele HBCI-Statuscode (sieheHBCIRetVal
) in den Statusdaten zu diesem Job gespeichert sind. Dabei werden die globalen Statusinformationen (die sich auf die gesamte Nachricht beziehen und nicht nur auf ein Segment dieses Jobs) nicht mitgezählt- Specified by:
getRetNumber
in interfaceHBCIJobResult
- Returns:
- Anzahl der HBCI-Statuscodes in den Job-Statusinformationen
-
getRetVal
public HBCIRetVal getRetVal(int idx)
Description copied from interface:HBCIJobResult
Gibt einen bestimmten HBCI-Statuscode aus den Job-Statusinformationen zurück. Die Anzahl der hier zur Verfügung stehenden Rückgabewerte kann mitHBCIJobResult.getRetNumber()
ermittelt werden.- Specified by:
getRetVal
in interfaceHBCIJobResult
- Parameters:
idx
- Indenummer des HBCI-Statuscodes (von 0 bis Anzahl-1)- Returns:
- einen HBCI-Statuscode
-
isOK
public boolean isOK()
Description copied from interface:HBCIJobResult
Gibt an, ob der Job erfolgreich ausgeführt wurde oder nicht.
Bei
true
ist der Job mit Sicherheit erfolgreich ausgeführt worden. Beifalse
kann es sein, dass der Job trotzdem ausgeführt wurde und nur die Antwortnachricht vom HBCI-Server nicht empfangen werden konnte oder fehlerhaft war. In diesem Fall sollte also die Fehlermeldung ausjobStatus.getErrorString()
bzw.globStatus.getErrorString()
genau ausgewertet werden.- Specified by:
isOK
in interfaceHBCIJobResult
- Returns:
true
, wenn der Auftrag mit Sicherheit erfolgreich eingereicht/ausgeführt wurde; sonstfalse
-
getDialogId
public java.lang.String getDialogId()
Description copied from interface:HBCIJobResult
Gibt die Dialog-ID zurück, unter der der dazugehörige Job ausgeführt wurde. Wird hauptsächlich intern verwendet. Zur Bereitstellung einer eindeutigen ID für den Job sieheHBCIJobResult.getJobId()
.- Specified by:
getDialogId
in interfaceHBCIJobResult
- Returns:
- Dialog-ID des Dialoges, in welchem der Job ausgeführt wurde
-
getMsgNum
public java.lang.String getMsgNum()
Description copied from interface:HBCIJobResult
Gibt die Nachrichtennummer innerhalb des Dialoges zurück, in dem der dazugehörige Job ausgeführt wurde. Wird hauptsächlich intern verwendet. Zur Bereitstellung einer eindeutigen ID für den Job sieheHBCIJobResult.getJobId()
.- Specified by:
getMsgNum
in interfaceHBCIJobResult
- Returns:
- Nachrichtennummer der Nachricht, in welcher der Job ausgeführt wurde
-
getSegNum
public java.lang.String getSegNum()
Description copied from interface:HBCIJobResult
Gibt die Segmentnummer des Segmentes innerhalb der Auftragsnachricht zurück, in welchem die Job-Daten übertragen wurden. Wird hauptsächlich intern verwendet. Zur Bereitstellung einer eindeutigen ID für den Job sieheHBCIJobResult.getJobId()
.- Specified by:
getSegNum
in interfaceHBCIJobResult
- Returns:
- Segmentnummer des Auftragssegmentes
-
getJobId
public java.lang.String getJobId()
Description copied from interface:HBCIJobResult
Gibt einen Job-Identifikationsstring zurück, mit dessen Hilfe sich der Job für dasStatusprotokoll
identifizieren lässt- Specified by:
getJobId
in interfaceHBCIJobResult
- Returns:
- die Job-Identifikationsnummer für den dazugehörigen Auftrag
-
getResultData
public java.util.Properties getResultData()
Description copied from interface:HBCIJobResult
Gibt die Job-Antwortdaten im Rohformat zurück. Für die Keys des Properties-Objektes gibt es zwei Ausprägungen:mit Prefix
content.
bzw.content_NUM.
:
Dieses Key-Value-Paar stellt ein Datenelement aus der Antwortnachricht dar. Der Rest des Keys (nach dem Prefix) gibt dabei den Lowlevel-Namen des Ergebnisdatenelementes an. Eine Liste aller möglichen Lowlevel-Namen kann zur Laufzeit mitHBCIHandler.getLowlevelJobResultNames(String)
oder mitHBCIJob.getJobResultNames()
ermittelt werden.mit Prefix
basic
:
Hier werden jobinterne Daten gespeichert:basic.dialogid
enthält die Dialog-ID, mit der der Job ausgeführt wurdebasic.msgnum
enthält die Nachrichtennummer innerhalb des Dialoges, in dem der Job ausgeführt wurdebasic.segnum
enthält die Segmentnummer innerhalb der Nachricht, in der der Job ausgeführt wurde
Diese Daten sollten niemals manuell ausgewertet werden, da es diese
basic
-Daten in Zukunft nicht mehr geben wird!
- Specified by:
getResultData
in interfaceHBCIJobResult
- Returns:
- die Antwortdaten im Rohformat
-
getGlobStatus
public HBCIStatus getGlobStatus()
Description copied from interface:HBCIJobResult
Gibt ein Status-Objekt zurück, welches Status-Informationen zur HBCI-Nachricht selbst enthält, in der die Job-Auftragsdaten übermittelt wurden.- Specified by:
getGlobStatus
in interfaceHBCIJobResult
- Returns:
- Statusinformationen zur Auftragsnachricht
-
getJobStatus
public HBCIStatus getJobStatus()
Description copied from interface:HBCIJobResult
Gibt ein Status-Objekt zurück, welches Status-Informationen über das Auftragssegment enthält, in dem die Job-Auftragsdaten übermittelt wurden.- Specified by:
getJobStatus
in interfaceHBCIJobResult
- Returns:
- Status-Informationen, die genau diesen Job betreffen
-
getPassport
public HBCIPassport getPassport()
Description copied from interface:HBCIJobResult
Gibt das Passport-Objekt zurück, für welches der Job erzeugt wurde.- Specified by:
getPassport
in interfaceHBCIJobResult
- Returns:
- Passport-Objekt
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getParentJob
public HBCIJob getParentJob()
-
-