Elexis API documentation
Version 2.1.6 as of December 11 2011

ch.rgw.tools
Class Result<T>

java.lang.Object
  extended by ch.rgw.tools.Result<T>

public class Result<T>
extends java.lang.Object

Universelles Rückgabe-Objekt. Ein Result beinhaltet die Information, ob ein Fehler erfolgt ist, ggf. den Schweregrad des Fehlers, ein Rückgabeobjekt (bei Erfolgreicher Ausführung), eine Fehlerbeschreibung bei Fehler. Ein Result kann mehrere Fehlermeldungen aufnehmen (und so durch mehrere Funktionen propagiert werden) Wenn ein Result mehr als ein Resultat enthält, so ist das Gesamtesultat das "schlimmste", also das mit der höchsten severity. Wenn ein Result gar kein Resultat enthält, so ist es "OK". Eine Methode kann entweder ein neues Result-Objekt erzeugen, oder ein übergebenes Resultobjekt um eine Meldung erweitern.

Author:
Gerry

Nested Class Summary
 class Result.msg
           
static class Result.SEVERITY
           
 
Constructor Summary
Result()
           
Result(Result.SEVERITY severity, int code, java.lang.String text, T result, boolean bLog)
           
Result(Result.SEVERITY sev, java.util.List<Result.msg> msgs)
           
Result(T result)
          Einen OK - Status abholen
 
Method Summary
 Result<T> add(Result.SEVERITY severity, int code, java.lang.String text, T result, boolean log)
          Ein neues Resultat hinzufügen
 Result<T> add(Result<T> r)
          Ein Result zu einem Result hinzufügen
 T get()
          Den "eigentlichen" Rückgabewert der Methode abholen
 int getCode()
           
 java.util.List<Result.msg> getMessages()
           
 Result.SEVERITY getSeverity()
           
 boolean isOK()
          Kurze Abfrage, ob alles fehlerfrei war
 java.lang.String toString()
          Return the result as String, cr-separated list of entries
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Result

public Result(T result)
Einen OK - Status abholen

Parameters:
result -

Result

public Result()

Result

public Result(Result.SEVERITY sev,
              java.util.List<Result.msg> msgs)

Result

public Result(Result.SEVERITY severity,
              int code,
              java.lang.String text,
              T result,
              boolean bLog)
Method Detail

getSeverity

public Result.SEVERITY getSeverity()

getCode

public int getCode()

getMessages

public java.util.List<Result.msg> getMessages()

isOK

public boolean isOK()
Kurze Abfrage, ob alles fehlerfrei war

Returns:
true wenn ja

get

public T get()
Den "eigentlichen" Rückgabewert der Methode abholen

Returns:

add

public Result<T> add(Result.SEVERITY severity,
                     int code,
                     java.lang.String text,
                     T result,
                     boolean log)
Ein neues Resultat hinzufügen

Parameters:
severity -
code -
text -
result -
log -
Returns:

add

public Result<T> add(Result<T> r)
Ein Result zu einem Result hinzufügen

Parameters:
r -
Returns:

toString

public java.lang.String toString()
Return the result as String, cr-separated list of entries

Overrides:
toString in class java.lang.Object

Elexis API documentation
Version 2.1.6 as of December 11 2011

Copyright 2005-2011 by Gerry Weirich, Elexis