HBCIStatus (hbci4j-adorsys 3.0.15 API)

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 and 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 Summary

Constructors
Constructor and Description

HBCIStatus()

Constructors
Constructor and Description
`HBCIStatus()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addException(Exception e)` Wird von der HBCI4Java-Dialog-Engine aufgerufen
`void`	`addRetVal(HBCIRetVal ret)` Wird von der HBCI4Java-Dialog-Engine aufgerufen
`List<HBCIRetVal>`	`getErrors()` Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurÃ¼ck
`String`	`getErrorString()` Gibt einen String zurÃ¼ck, der alle Fehlermeldungen der hier enthaltenen RÃ¼ckgabewerte im Klartext enthÃ¤lt.
`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.
`List<HBCIRetVal>`	`getSuccess()` Gibt die in diesem Objekt gespeicherten Erfolgsmeldungen zurÃ¼ck
`List<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.
`String`	`toString()` 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 Detail
  - STATUS_OK
```
public static final int STATUS_OK
```
    Statuscode fÃ¼r "alle Statusinformationen besagen OK"
    
    See Also:
    
    Constant Field Values
  - 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
  - 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
  - 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
  - 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 List<HBCIRetVal> getErrors()
```
    Gibt die in diesem Objekt gespeicherten Fehlermeldungen zurÃ¼ck
    
    Returns:
    
    Array mit HBCI-Returncodes, die allesamt Fehlermeldungen beschreiben
  - getWarnings
```
public List<HBCIRetVal> getWarnings()
```
    Gibt die in diesem Objekt gespeicherten Warnungen zurÃ¼ck
    
    Returns:
    
    Array mit HBCI-Returncodes, die allesamt Warnmeldungen beschreiben
  - getSuccess
```
public List<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

Class HBCIStatus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_OK

STATUS_UNKNOWN

STATUS_ERR

Constructor Detail

HBCIStatus

Method Detail

addException

addRetVal

hasExceptions

hasErrors

hasWarnings

hasSuccess

getExceptions

getRetVals

getErrors

getWarnings

getSuccess

getStatusCode

isOK

getErrorString

toString