Class HBCIStatus

java.lang.Object
org.kapott.hbci.status.HBCIStatus

public final class HBCIStatus extends Object

Menge zusammengehöriger Status-Informationen. In Objekten dieser Klasse kann eine Menge von HBCI-Statuscodes sowie eine Menge von Exceptions gespeichert werden. Der Sinn dieser Klasse ist die Zusammenfassung von mehreren Status-Informationen, die logisch zusammengehören (z.B. alle Status-Informationen, die ein bestimmtes Nachrichtensegment betreffen).

Objekte dieser Klasse werden beispielsweise in HBCIMsgStatus verwendet, um globale und segmentbezogene Status-Informationen voneinander getrennt zu sammeln.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private List<Exception>
     
    private List<HBCIRetVal>
     
    static final int
    Statuscode für "es ist mindestens ein Fehlercode enthalten"
    static final int
    Statuscode für "alle Statusinformationen besagen OK"
    static final int
    Statuscode für "Gesamtstatus kann nicht ermittelt werden".
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Wird von der HBCI4Java-Dialog-Engine aufgerufen
    void
    Wird von der HBCI4Java-Dialog-Engine aufgerufen
    Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurück
    Gibt einen String zurück, der alle Fehlermeldungen der hier enthaltenen Rückgabewerte im Klartext enthält.
    Gibt die in diesem Status-Objekt gespeicherten Exceptions zurück
    Gibt alle in diesem Status-Objekt gespeicherten Rückgabewerte zurück
    int
    Gibt einen Code zurück, der den zusammengefassten Status aller in diesem Objekt gespeicherten Rückgabewerte beschreibt.
    Gibt die in diesem Objekt gespeicherten Erfolgsmeldungen zurück
    Gibt die in diesem Objekt gespeicherten Warnungen zurück
    private HBCIRetVal[]
    getX(char code)
     
    boolean
    Gibt zurück, ob in den Rückgabedaten in diesem Objekt Fehlermeldungen enthalten sind
    boolean
    Gibt zurück, ob in diesem Status-Objekt Exceptions gespeichert sind
    boolean
    Gibt zurück, ob in den Rückgabedaten in diesem Objekt Erfolgsmeldungen enthalten sind
    boolean
    Gibt zurück, ob in den Rückgabedaten in diesem Objekt Warnungen enthalten sind
    private boolean
    hasX(char code)
     
    boolean
    Gibt true zurück, wenn keine Fehlermeldungen bzw.
    Gibt die Status-Informationen aller enthaltenen Exceptions und HBCI-Rückgabewerte als ein String zurück.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • STATUS_OK

      public static final int STATUS_OK
      Statuscode für "alle Statusinformationen besagen OK"
      See Also:
    • STATUS_UNKNOWN

      public static final int STATUS_UNKNOWN
      Statuscode für "Gesamtstatus kann nicht ermittelt werden". (z.B. weil gar keine Informationen in diesem Objekt enthalten sind)
      See Also:
    • STATUS_ERR

      public static final int STATUS_ERR
      Statuscode für "es ist mindestens ein Fehlercode enthalten"
      See Also:
    • retVals

      private List<HBCIRetVal> retVals
    • exceptions

      private List<Exception> exceptions
  • Constructor Details

    • HBCIStatus

      public HBCIStatus()
  • Method Details

    • addException

      public void addException(Exception e)
      Wird von der HBCI4Java-Dialog-Engine aufgerufen
    • addRetVal

      public void addRetVal(HBCIRetVal ret)
      Wird von der HBCI4Java-Dialog-Engine aufgerufen
    • hasExceptions

      public boolean hasExceptions()
      Gibt zurück, ob in diesem Status-Objekt Exceptions gespeichert sind
      Returns:
      true, falls Exceptions gespeichert sind, sonst false
    • hasX

      private boolean hasX(char code)
    • hasErrors

      public boolean hasErrors()
      Gibt zurück, ob in den Rückgabedaten in diesem Objekt Fehlermeldungen enthalten sind
      Returns:
      true, falls Fehlermeldungen vorhanden sind, sonst false
    • hasWarnings

      public boolean hasWarnings()
      Gibt zurück, ob in den Rückgabedaten in diesem Objekt Warnungen enthalten sind
      Returns:
      true, falls Warnungen vorhanden sind, sonst false
    • hasSuccess

      public boolean hasSuccess()
      Gibt zurück, ob in den Rückgabedaten in diesem Objekt Erfolgsmeldungen enthalten sind
      Returns:
      true, falls Erfolgsmeldungen vorhanden sind, sonst false
    • getX

      private HBCIRetVal[] getX(char code)
    • getExceptions

      public Exception[] getExceptions()
      Gibt die in diesem Status-Objekt gespeicherten Exceptions zurück
      Returns:
      Array mit Exceptions, die während der HBCI-Kommunikation aufgetreten sind.
    • getRetVals

      public HBCIRetVal[] getRetVals()
      Gibt alle in diesem Status-Objekt gespeicherten Rückgabewerte zurück
      Returns:
      Array mit HBCIRetVals, die während der HBCI-Kommunikation aufgetreten sind.
    • getErrors

      public HBCIRetVal[] getErrors()
      Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurück
      Returns:
      Array mit HBCI-Returncodes, die allesamt Fehlermeldungen beschreiben
    • getWarnings

      public HBCIRetVal[] getWarnings()
      Gibt die in diesem Objekt gespeicherten Warnungen zurück
      Returns:
      Array mit HBCI-Returncodes, die allesamt Warnmeldungen beschreiben
    • getSuccess

      public HBCIRetVal[] getSuccess()
      Gibt die in diesem Objekt gespeicherten Erfolgsmeldungen zurück
      Returns:
      Array mit HBCI-Returncodes, die allesamt Erfolgsmeldungen beschreiben
    • getStatusCode

      public int getStatusCode()
      Gibt einen Code zurück, der den zusammengefassten Status aller in diesem Objekt gespeicherten Rückgabewerte beschreibt. Dafür gibt es folgende Möglichkeiten:
      • STATUS_OK wird zurückgegeben, wenn es keine Fehlermeldungen oder Exceptions gegeben hat und mindestens eine Erfolgsmeldung oder Warnung enthalten ist
      • STATUS_ERR wird zurückgegeben, wenn wenigstens eine Exception aufgetreten ist oder wenigstens eine Fehlermeldung enthalten ist.
      • STATUS_UNKNOWN wird zurückgegeben, wenn keine der beiden o.g. Bedingungen zutrifft.
      Returns:
      einen Code, der den zusammengefassten Status aller Rückgabewerte beschreibt.
    • isOK

      public boolean isOK()
      Gibt true zurück, wenn keine Fehlermeldungen bzw. Exceptions aufgetreten sind und wenigstens eine Successmeldung oder Warnung enthalten ist
    • getErrorString

      public String getErrorString()
      Gibt einen String zurück, der alle Fehlermeldungen der hier enthaltenen Rückgabewerte im Klartext enthält. Für evtl. enthaltene Exception wird die entsprechende Beschreibung in Kurz (siehe HBCIUtils.exception2StringShort(Exception)) benutzt.
      Returns:
      String mit allen Fehlermeldungen
    • toString

      public String toString()
      Gibt die Status-Informationen aller enthaltenen Exceptions und HBCI-Rückgabewerte als ein String zurück.
      Overrides:
      toString in class Object
      Returns:
      String mit allen gespeicherten Status-Informationen