public interface HBCIJobResult
Modifier and Type | Method and 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 das
Statusprotokoll identifizieren lässt |
HBCIStatus |
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.
|
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 (siehe
HBCIRetVal ) 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.
|
int getRetNumber()
HBCIRetVal
) 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ähltHBCIRetVal getRetVal(int idx)
getRetNumber()
ermittelt werden.idx
- Indenummer des HBCI-Statuscodes (von 0 bis Anzahl-1)boolean isOK()
Gibt an, ob der Job erfolgreich ausgeführt wurde oder nicht.
Bei true
ist der Job mit Sicherheit erfolgreich ausgeführt worden.
Bei false
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 aus
jobStatus.getErrorString()
bzw.
globStatus.getErrorString()
genau ausgewertet werden.
true
, wenn der Auftrag mit Sicherheit erfolgreich
eingereicht/ausgeführt wurde; sonst false
java.lang.String getDialogId()
getJobId()
.java.lang.String getMsgNum()
getJobId()
.java.lang.String getSegNum()
getJobId()
.java.lang.String getJobId()
Statusprotokoll
identifizieren lässtjava.util.Properties getResultData()
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 mit
HBCIHandler.getLowlevelJobResultNames(String)
oder mit HBCIJob.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 wurdeDiese Daten sollten niemals manuell ausgewertet werden, da es diese basic
-Daten
in Zukunft nicht mehr geben wird!
HBCIStatus getGlobStatus()
HBCIStatus getJobStatus()
HBCIPassport getPassport()