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 HBCIStatusglobStatusHBCIStatusjobStatus
-
Constructor Summary
Constructors Constructor Description HBCIJobResultImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetDialogId()Gibt die Dialog-ID zurück, unter der der dazugehörige Job ausgeführt wurde.HBCIStatusgetGlobStatus()Gibt ein Status-Objekt zurück, welches Status-Informationen zur HBCI-Nachricht selbst enthält, in der die Job-Auftragsdaten übermittelt wurden.java.lang.StringgetJobId()Gibt einen Job-Identifikationsstring zurück, mit dessen Hilfe sich der Job für dasStatusprotokollidentifizieren lässtHBCIStatusgetJobStatus()Gibt ein Status-Objekt zurück, welches Status-Informationen über das Auftragssegment enthält, in dem die Job-Auftragsdaten übermittelt wurden.java.lang.StringgetMsgNum()Gibt die Nachrichtennummer innerhalb des Dialoges zurück, in dem der dazugehörige Job ausgeführt wurde.HBCIJobgetParentJob()HBCIPassportgetPassport()Gibt das Passport-Objekt zurück, für welches der Job erzeugt wurde.java.util.PropertiesgetResultData()Gibt die Job-Antwortdaten im Rohformat zurück.intgetRetNumber()Gibt zurück, wieviele HBCI-Statuscode (sieheHBCIRetVal) in den Statusdaten zu diesem Job gespeichert sind.HBCIRetValgetRetVal(int idx)Gibt einen bestimmten HBCI-Statuscode aus den Job-Statusinformationen zurück.java.lang.StringgetSegNum()Gibt die Segmentnummer des Segmentes innerhalb der Auftragsnachricht zurück, in welchem die Job-Daten übertragen wurden.booleanisOK()Gibt an, ob der Job erfolgreich ausgeführt wurde oder nicht.voidsetParentJob(HBCIJobImpl parentJob)voidstoreResult(java.lang.String key, java.lang.String value)java.lang.StringtoString()
-
-
-
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:HBCIJobResultGibt 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:
getRetNumberin interfaceHBCIJobResult- Returns:
- Anzahl der HBCI-Statuscodes in den Job-Statusinformationen
-
getRetVal
public HBCIRetVal getRetVal(int idx)
Description copied from interface:HBCIJobResultGibt 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:
getRetValin interfaceHBCIJobResult- Parameters:
idx- Indenummer des HBCI-Statuscodes (von 0 bis Anzahl-1)- Returns:
- einen HBCI-Statuscode
-
isOK
public boolean isOK()
Description copied from interface:HBCIJobResultGibt an, ob der Job erfolgreich ausgeführt wurde oder nicht.
Bei
trueist der Job mit Sicherheit erfolgreich ausgeführt worden. Beifalsekann 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:
isOKin interfaceHBCIJobResult- Returns:
true, wenn der Auftrag mit Sicherheit erfolgreich eingereicht/ausgeführt wurde; sonstfalse
-
getDialogId
public java.lang.String getDialogId()
Description copied from interface:HBCIJobResultGibt 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:
getDialogIdin interfaceHBCIJobResult- Returns:
- Dialog-ID des Dialoges, in welchem der Job ausgeführt wurde
-
getMsgNum
public java.lang.String getMsgNum()
Description copied from interface:HBCIJobResultGibt 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:
getMsgNumin interfaceHBCIJobResult- Returns:
- Nachrichtennummer der Nachricht, in welcher der Job ausgeführt wurde
-
getSegNum
public java.lang.String getSegNum()
Description copied from interface:HBCIJobResultGibt 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:
getSegNumin interfaceHBCIJobResult- Returns:
- Segmentnummer des Auftragssegmentes
-
getJobId
public java.lang.String getJobId()
Description copied from interface:HBCIJobResultGibt einen Job-Identifikationsstring zurück, mit dessen Hilfe sich der Job für dasStatusprotokollidentifizieren lässt- Specified by:
getJobIdin interfaceHBCIJobResult- Returns:
- die Job-Identifikationsnummer für den dazugehörigen Auftrag
-
getResultData
public java.util.Properties getResultData()
Description copied from interface:HBCIJobResultGibt 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.dialogidenthält die Dialog-ID, mit der der Job ausgeführt wurdebasic.msgnumenthält die Nachrichtennummer innerhalb des Dialoges, in dem der Job ausgeführt wurdebasic.segnumenthä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:
getResultDatain interfaceHBCIJobResult- Returns:
- die Antwortdaten im Rohformat
-
getGlobStatus
public HBCIStatus getGlobStatus()
Description copied from interface:HBCIJobResultGibt ein Status-Objekt zurück, welches Status-Informationen zur HBCI-Nachricht selbst enthält, in der die Job-Auftragsdaten übermittelt wurden.- Specified by:
getGlobStatusin interfaceHBCIJobResult- Returns:
- Statusinformationen zur Auftragsnachricht
-
getJobStatus
public HBCIStatus getJobStatus()
Description copied from interface:HBCIJobResultGibt ein Status-Objekt zurück, welches Status-Informationen über das Auftragssegment enthält, in dem die Job-Auftragsdaten übermittelt wurden.- Specified by:
getJobStatusin interfaceHBCIJobResult- Returns:
- Status-Informationen, die genau diesen Job betreffen
-
getPassport
public HBCIPassport getPassport()
Description copied from interface:HBCIJobResultGibt das Passport-Objekt zurück, für welches der Job erzeugt wurde.- Specified by:
getPassportin interfaceHBCIJobResult- Returns:
- Passport-Objekt
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getParentJob
public HBCIJob getParentJob()
-
-