org.kapott.hbci.status
Class HBCIMsgStatus

java.lang.Object
  |
  +--org.kapott.hbci.status.HBCIMsgStatus

public final class HBCIMsgStatus
extends java.lang.Object

Enthält alle Status-Informationen zu genau einem Nachrichtenaustausch. Es ist zu beachten, dass in einer Nachricht Informationen zu mehreren Geschäftsvorfällen enthalten sein können, wenn die gesendete Nachricht mehrere Aufträge enthalten hat.

Die direkte Auswertung der Felder dieser Klasse wird nicht empfohlen, statt dessen sollten nur die Methoden benutzt werden, die den prinzipiellen Status (OK oder nicht OK) sowie die eigentlichen Fehler-Informationen zurückgeben.


Field Summary
 HBCIStatus globStatus
          Globale Status-Informationen.
 HBCIStatus segStatus
          Status-Informationen, die einzelne Segmente der Nachricht betreffen.
 
Method Summary
 java.util.Properties getData()
          Gibt den eigentlichen Inhalt sowohl der gesendeten wie auch der empfangenen Nachricht zurück.
 java.lang.String getErrorString()
          Gibt einen String zurück, der alle aufgetretenen Fehler bei der Durchführung des Nachrichtenaustauschs beschreibt.
 java.lang.Exception[] getExceptions()
          Gibt die Exceptions zurück, ob bei der Ausführung eines Nachrichtenaustauschs aufgetreten sind.
 boolean hasExceptions()
          Gibt zurück, ob bei der Ausführung eines Nachrichtenaustauschs Exceptions aufgetreten sind.
 boolean isOK()
          Gibt zurück, ob ein Nachrichtenaustausch erfolgreich durchgeführt wurde.
 java.lang.String toString()
          Fasst alle Status-Informationen zu einem Nachrichtenaustausch in einem einzigen String zusammen und gibt diesen zurück.
 

Field Detail

globStatus

public HBCIStatus globStatus
Globale Status-Informationen. Das sind Informationen, die die Nachricht als ganzes betreffen (z.B. wenn die Nachricht nicht signiert oder verschlüsselt war, oder wenn sie nicht dekodiert werden konnte etc.)


segStatus

public HBCIStatus segStatus
Status-Informationen, die einzelne Segmente der Nachricht betreffen. Hier werden alle Rückgabecodes gespeichert, die sich konkret auf einzelne Segmente der gesendeten Nachricht beziehen.

Method Detail

getData

public java.util.Properties getData()

Gibt den eigentlichen Inhalt sowohl der gesendeten wie auch der empfangenen Nachricht zurück. Die keys des Property-Objektes enthalten die Lowlevelnamen der Datenelemente, die dazugehörigen values enthalten jeweils den Wert des entsprechenden Datenelementes. Die Bezeichnungen der Datenelemente der gesendeten Nachricht tragen zur Unterscheidung mit den Datenelementen der empfangenen Nachricht das Prefix "orig_".


hasExceptions

public boolean hasExceptions()
Gibt zurück, ob bei der Ausführung eines Nachrichtenaustauschs Exceptions aufgetreten sind. Diese Exceptions können entweder beim Erzeugen bzw. Versenden der Kundennachricht oder aber beim Empfangen und Auswerten der Institutsnachricht aufgetreten sein.

Returns:
true, wenn Exceptions aufgetreten sind, sonst false

getExceptions

public java.lang.Exception[] getExceptions()
Gibt die Exceptions zurück, ob bei der Ausführung eines Nachrichtenaustauschs aufgetreten sind. Diese Exceptions können entweder beim Erzeugen bzw. Versenden der Kundennachricht oder aber beim Empfangen und Auswerten der Institutsnachricht aufgetreten sein.

Returns:
Array mit aufgetretenen Exceptions, ist niemals null, kann aber die Länge 0 haben

isOK

public boolean isOK()
Gibt zurück, ob ein Nachrichtenaustausch erfolgreich durchgeführt wurde. Das ist dann der Fall, wenn bei der Abarbeitung keine Exceptions aufgetreten sind und die Antwortnachricht eine Erfolgsmeldung oder zumindest nur Warnungen (aber keine Fehlermeldung) enthält.

Returns:
true, wenn die Nachricht erfolgreich abgearbeitet wurde, sonst false

getErrorString

public java.lang.String getErrorString()
Gibt einen String zurück, der alle aufgetretenen Fehler bei der Durchführung des Nachrichtenaustauschs beschreibt. Dieser String besteht aus allen Exception-Meldungen sowie allen evtl. empfangenen Fehlermeldungen. Die Meldungen werden aus den einzelnen HBCIStatus-Objekten durch Aufruf der Methode HBCIStatus.getErrorString() erzeugt.

Returns:
String mit allen aufgetretenen Fehlermeldungen

toString

public java.lang.String toString()
Fasst alle Status-Informationen zu einem Nachrichtenaustausch in einem einzigen String zusammen und gibt diesen zurück. Dazu gehören alle evtl. aufgetretenen Exception-Meldungen, alle Fehlermeldungen, Warnungen sowie Erfolgsmeldungen. Die Meldungen werden aus den einzelnen HBCIStatus-Objekten durch Aufruf der Methode HBCIStatus.toString() erzeugt.

Overrides:
toString in class java.lang.Object
Returns:
einen String, der alle Status-Informationen zu einer Nachricht enthält