Package org.kapott.hbci.status
Class HBCIStatus
java.lang.Object
org.kapott.hbci.status.HBCIStatus
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
FieldsModifier and TypeFieldDescriptionprivate 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Wird von der HBCI4Java-Dialog-Engine aufgerufenvoid
addRetVal
(HBCIRetVal ret) Wird von der HBCI4Java-Dialog-Engine aufgerufenGibt die in diesem Objekt gespeicherten Fehlermeldungen zurückGibt 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ückGibt alle in diesem Status-Objekt gespeicherten Rückgabewerte zurückint
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ückGibt die in diesem Objekt gespeicherten Warnungen zurückprivate HBCIRetVal[]
getX
(char code) boolean
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Fehlermeldungen enthalten sindboolean
Gibt zurück, ob in diesem Status-Objekt Exceptions gespeichert sindboolean
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Erfolgsmeldungen enthalten sindboolean
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Warnungen enthalten sindprivate boolean
hasX
(char code) boolean
isOK()
Gibttrue
zurück, wenn keine Fehlermeldungen bzw.toString()
Gibt die Status-Informationen aller enthaltenen Exceptions und HBCI-Rückgabewerte als ein String zurück.
-
Field Details
-
STATUS_OK
public static final int STATUS_OKStatuscode für "alle Statusinformationen besagen OK"- See Also:
-
STATUS_UNKNOWN
public static final int STATUS_UNKNOWNStatuscode 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_ERRStatuscode für "es ist mindestens ein Fehlercode enthalten"- See Also:
-
retVals
-
exceptions
-
-
Constructor Details
-
HBCIStatus
public HBCIStatus()
-
-
Method Details
-
addException
Wird von der HBCI4Java-Dialog-Engine aufgerufen -
addRetVal
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, sonstfalse
-
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, sonstfalse
-
hasWarnings
public boolean hasWarnings()Gibt zurück, ob in den Rückgabedaten in diesem Objekt Warnungen enthalten sind- Returns:
true
, falls Warnungen vorhanden sind, sonstfalse
-
hasSuccess
public boolean hasSuccess()Gibt zurück, ob in den Rückgabedaten in diesem Objekt Erfolgsmeldungen enthalten sind- Returns:
true
, falls Erfolgsmeldungen vorhanden sind, sonstfalse
-
getX
-
getExceptions
Gibt die in diesem Status-Objekt gespeicherten Exceptions zurück- Returns:
- Array mit Exceptions, die während der HBCI-Kommunikation aufgetreten sind.
-
getRetVals
Gibt alle in diesem Status-Objekt gespeicherten Rückgabewerte zurück- Returns:
- Array mit
HBCIRetVal
s, die während der HBCI-Kommunikation aufgetreten sind.
-
getErrors
Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurück- Returns:
- Array mit HBCI-Returncodes, die allesamt Fehlermeldungen beschreiben
-
getWarnings
Gibt die in diesem Objekt gespeicherten Warnungen zurück- Returns:
- Array mit HBCI-Returncodes, die allesamt Warnmeldungen beschreiben
-
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 istSTATUS_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()Gibttrue
zurück, wenn keine Fehlermeldungen bzw. Exceptions aufgetreten sind und wenigstens eine Successmeldung oder Warnung enthalten ist -
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 (sieheHBCIUtils.exception2StringShort(Exception)
) benutzt.- Returns:
- String mit allen Fehlermeldungen
-
toString
Gibt die Status-Informationen aller enthaltenen Exceptions und HBCI-Rückgabewerte als ein String zurück.
-