public final class HBCIStatus
extends java.lang.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.
Modifier and Type | Field | Description |
---|---|---|
static int |
STATUS_ERR |
Statuscode für "es ist mindestens ein Fehlercode enthalten"
|
static int |
STATUS_OK |
Statuscode für "alle Statusinformationen besagen OK"
|
static int |
STATUS_UNKNOWN |
Statuscode für "Gesamtstatus kann nicht ermittelt werden".
|
Constructor | Description |
---|---|
HBCIStatus() |
Modifier and Type | Method | Description |
---|---|---|
void |
addException(java.lang.Exception e) |
Wird von der HBCI4Java-Dialog-Engine aufgerufen
|
void |
addRetVal(HBCIRetVal ret) |
Wird von der HBCI4Java-Dialog-Engine aufgerufen
|
HBCIRetVal[] |
getErrors() |
Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurück
|
java.lang.String |
getErrorString() |
Gibt einen String zurück, der alle Fehlermeldungen der hier enthaltenen
Rückgabewerte im Klartext enthält.
|
java.lang.Exception[] |
getExceptions() |
Gibt die in diesem Status-Objekt gespeicherten Exceptions zurück
|
HBCIRetVal[] |
getRetVals() |
Gibt alle in diesem Status-Objekt gespeicherten Rückgabewerte zurück
|
int |
getStatusCode() |
Gibt einen Code zurück, der den zusammengefassten Status aller in diesem
Objekt gespeicherten Rückgabewerte beschreibt.
|
HBCIRetVal[] |
getSuccess() |
Gibt die in diesem Objekt gespeicherten Erfolgsmeldungen zurück
|
HBCIRetVal[] |
getWarnings() |
Gibt die in diesem Objekt gespeicherten Warnungen zurück
|
boolean |
hasErrors() |
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Fehlermeldungen
enthalten sind
|
boolean |
hasExceptions() |
Gibt zurück, ob in diesem Status-Objekt Exceptions gespeichert sind
|
boolean |
hasSuccess() |
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Erfolgsmeldungen
enthalten sind
|
boolean |
hasWarnings() |
Gibt zurück, ob in den Rückgabedaten in diesem Objekt Warnungen
enthalten sind
|
boolean |
isOK() |
Gibt
true zurück, wenn keine Fehlermeldungen bzw. |
java.lang.String |
toString() |
Gibt die Status-Informationen aller enthaltenen Exceptions und
HBCI-Rückgabewerte als ein String zurück.
|
public static final int STATUS_OK
public static final int STATUS_UNKNOWN
public static final int STATUS_ERR
public void addException(java.lang.Exception e)
public void addRetVal(HBCIRetVal ret)
public boolean hasExceptions()
true
, falls Exceptions gespeichert sind,
sonst false
public boolean hasErrors()
true
, falls Fehlermeldungen vorhanden sind,
sonst false
public boolean hasWarnings()
true
, falls Warnungen vorhanden sind,
sonst false
public boolean hasSuccess()
true
, falls Erfolgsmeldungen vorhanden sind,
sonst false
public java.lang.Exception[] getExceptions()
public HBCIRetVal[] getRetVals()
HBCIRetVal
s, die während der HBCI-Kommunikation
aufgetreten sind.public HBCIRetVal[] getErrors()
public HBCIRetVal[] getWarnings()
public HBCIRetVal[] getSuccess()
public int getStatusCode()
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.public boolean isOK()
true
zurück, wenn keine Fehlermeldungen bzw. Exceptions
aufgetreten sind und wenigstens eine Successmeldung oder Warnung enthalten
istpublic java.lang.String getErrorString()
HBCIUtils.exception2StringShort(Exception)
)
benutzt.public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2018. All rights reserved.