Package org.kapott.hbci.status

Class 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 Detail

      • 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:
        Constant Field Values

      • STATUS_ERR

        public static final int STATUS_ERR
        Statuscode für "es ist mindestens ein Fehlercode enthalten"
        See Also:
        Constant Field Values

    • Constructor Detail

      • HBCIStatus

        public HBCIStatus()

    • Method Detail

      • addRetVal

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

      • 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

      • 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 List<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.

      • getWarnings

        public List<HBCIRetVal> getWarnings()
        Gibt die in diesem Objekt gespeicherten Warnungen zurück
        Returns:
        Array mit HBCI-Returncodes, die allesamt Warnmeldungen 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

      • getErrorList

        public List<String> getErrorList()
        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

      • getWarningsList

        public List<String> getWarningsList()

      • 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