org.kapott.hbci.status
Class HBCIRetVal

java.lang.Object
  extended byorg.kapott.hbci.status.HBCIRetVal
All Implemented Interfaces:
java.io.Serializable

public final class HBCIRetVal
extends java.lang.Object
implements java.io.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:
Serialized Form

Field Summary
 java.lang.String code
          HBCI-Fehlercode.
 java.lang.String deref
          Nummer des Datenelementes oder der Datenelementgruppe, auf das sich dieser Rückgabewert bezieht.
 java.lang.String element
          Lowlevel-Name des Nachrichtenelementes, auf das sich dieser Rückgabewert bezieht.
 java.lang.String[] params
          Optionale Parameter, die im Zusammenhang mit text zu interpretieren sind.
 java.lang.String segref
          Segmentnummer in der gesendeten Nachricht, auf das sich dieser Rückgabewert bezieht.
 java.lang.String text
          Beschreibender Text.
 
Constructor Summary
HBCIRetVal(java.util.Properties result, java.lang.String header)
          Wird von der HBCI4Java-Dialog-Engine aufgerufen
HBCIRetVal(java.util.Properties result, java.lang.String header, java.lang.String segref)
          Wird von der HBCI4Java-Dialog-Engine aufgerufen
HBCIRetVal(java.lang.String segref, java.lang.String deref, java.lang.String element, java.lang.String code, java.lang.String text, java.lang.String[] params)
          Wird von der HBCI4Java-Dialog-Engine aufgerufen
 
Method Summary
 boolean equals(java.lang.Object o)
           
 boolean isError()
          Gibt zurück, ob dieser Rückgabewert eine HBCI-Fehlermeldung darstellt
 boolean isSuccess()
          Gibt zurück, ob dieser Rückgabewert eine Erfolgsmeldung vom HBCI-Server darstellt
 boolean isWarning()
          Gibt zurück, ob dieser Rückgabewert eine Warnung vom HBCI-Server darstellt
 java.lang.String toString()
          Gibt diesen Rückgabewert in einer lesbaren Darstellung zurück.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code

public java.lang.String code

HBCI-Fehlercode. Diese Codes bestehen immer aus vier Ziffern. Die erste Ziffer kennzeichnet dabei die Art:


segref

public java.lang.String 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 Wert null


deref

public java.lang.String 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 Wert null.


text

public java.lang.String text
Beschreibender Text. Dieser Text wird vom HBCI-Server der Bank generiert.


params

public java.lang.String[] params
Optionale Parameter, die im Zusammenhang mit text zu interpretieren sind.


element

public java.lang.String 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 auch null sein.

Constructor Detail

HBCIRetVal

public HBCIRetVal(java.lang.String segref,
                  java.lang.String deref,
                  java.lang.String element,
                  java.lang.String code,
                  java.lang.String text,
                  java.lang.String[] params)
Wird von der HBCI4Java-Dialog-Engine aufgerufen


HBCIRetVal

public HBCIRetVal(java.util.Properties result,
                  java.lang.String header)
Wird von der HBCI4Java-Dialog-Engine aufgerufen


HBCIRetVal

public HBCIRetVal(java.util.Properties result,
                  java.lang.String header,
                  java.lang.String segref)
Wird von der HBCI4Java-Dialog-Engine aufgerufen

Method Detail

toString

public java.lang.String toString()
Gibt diesen Rückgabewert in einer lesbaren Darstellung zurück.

Returns:
einen String, der alle Informationen dieses Objektes kurz zusammenfasst.

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

public boolean equals(java.lang.Object o)