Class HBCIRetVal
- All Implemented Interfaces:
Serializable
Repräsentation eines HBCI-Statuscodes. Objekte dieser Klasse stellen einen einzigen HBCI-Returncode dar, welcher aus einer Antwortnachricht von der Bank extrahiert wurde.
Zu den hier bereitgestellten Informationen zählen neben den eigentlichen Status-Daten (Status-Code, Textmeldung) auch eine numerische Darstellung des Teiles der ursprünglich gesendeten Nachricht, auf den sich diese Statusmeldung bezieht. Sofern das möglich ist, wird diese numerische Darstellung zusätzlich in den Lowlevel-Namen des betreffenden Nachrichtenteils umgewandelt, so dass für den Anwender eine bessere Lokalisierung des Problems möglich ist.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionHBCI-Fehlercode.Nummer des Datenelementes oder der Datenelementgruppe, auf das sich dieser Rückgabewert bezieht.Lowlevel-Name des Nachrichtenelementes, auf das sich dieser Rückgabewert bezieht.String[]
Optionale Parameter, die im Zusammenhang mittext
zu interpretieren sind.Segmentnummer in der gesendeten Nachricht, auf das sich dieser Rückgabewert bezieht.Beschreibender Text. -
Constructor Summary
ConstructorsConstructorDescriptionWird von der HBCI4Java-Dialog-Engine aufgerufenHBCIRetVal
(Properties result, String header) Wird von der HBCI4Java-Dialog-Engine aufgerufenHBCIRetVal
(Properties result, String header, String segref) Wird von der HBCI4Java-Dialog-Engine aufgerufen -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
isError()
Gibt zurück, ob dieser Rückgabewert eine HBCI-Fehlermeldung darstelltboolean
Gibt zurück, ob dieser Rückgabewert eine Erfolgsmeldung vom HBCI-Server darstelltboolean
Gibt zurück, ob dieser Rückgabewert eine Warnung vom HBCI-Server darstellttoString()
Gibt diesen Rückgabewert in einer lesbaren Darstellung zurück.
-
Field Details
-
code
HBCI-Fehlercode. Diese Codes bestehen immer aus vier Ziffern. Die erste Ziffer kennzeichnet dabei die Art:
0 - Erfolgsmeldung
3 - Warnung
9 - Fehlermeldung
-
segref
Segmentnummer in der gesendeten Nachricht, auf das sich dieser Rückgabewert bezieht. Falls es sich um einen globalen Rückgabewert handelt (d.h. einen, der sich auf die komplette Nachricht bezieht), so ist dieser Wertnull
-
deref
Nummer des Datenelementes oder der Datenelementgruppe, auf das sich dieser Rückgabewert bezieht. Diese Information ist nicht in jedem Fall vorhanden (z.B. wenn es sich um einen globalen Fehlercode handelt oder wenn sich der Rückgabewert auf ein komplettes Segment bezieht). In einem solchen Fall ist dieser Wertnull
. -
text
Beschreibender Text. Dieser Text wird vom HBCI-Server der Bank generiert. -
params
Optionale Parameter, die im Zusammenhang mittext
zu interpretieren sind. -
element
Lowlevel-Name des Nachrichtenelementes, auf das sich dieser Rückgabewert bezieht. Dieser Name kann nicht in jedem Fall bestimmt werden, der Wert dieses Feldes kann dann auchnull
sein.
-
-
Constructor Details
-
Method Details
-
toString
Gibt diesen Rückgabewert in einer lesbaren Darstellung zurück. -
isSuccess
public boolean isSuccess()Gibt zurück, ob dieser Rückgabewert eine Erfolgsmeldung vom HBCI-Server darstellt -
isWarning
public boolean isWarning()Gibt zurück, ob dieser Rückgabewert eine Warnung vom HBCI-Server darstellt -
isError
public boolean isError()Gibt zurück, ob dieser Rückgabewert eine HBCI-Fehlermeldung darstellt -
equals
-