de.werum.dguv.mgnr.plausi
Interface PlausiResult


public interface PlausiResult

Die Schnittstelle PlausiResult repräsentiert das Ergebnis einer Mitgliedsnummerprüfung. Neben dem Fehlerstatus sind auch der Fehlertext, die vorgegebene Prüfgenauigkeit, die verwendete Prüfgenauigkeit und die Version der verwendeten PL abfragbar.

Version:
1.0
Author:
haehnel

Field Summary
static int CHECK_ACCURACY_AGAINST_STOCK
          Das Feld CHECK_ACCURACY_AGAINST_STOCK definiert den Prüfgenauigkeit, wenn die Mitgliedsnummer gegen den Bestand geprüft wird.
static int CHECK_ACCURACY_FULL
          Das Feld CHECK_ACCURACY_FULL definiert den Prüfgenauigkeit, wenn eine komplette Prüfung der Mitgliedsnummer mit Formatierung und Prüfziffern durchgeführt wird.
static int CHECK_ACCURACY_LENGTH_AND_CHARS
          Das Feld CHECK_ACCURACY_LENGTH_AND_CHARS definiert den Prüfgenauigkeit, wenn nur Länge und zulässige Zeichen geprüft werden.
static int ERROR_STATUS_NO_CHECK
          Das Feld ERROR_STATUS_NO_CHECK definiert den Ergebnisstatus, wenn keine Prüfung durchgeführt wurde.
static int ERROR_STATUS_OK
          Das Feld ERROR_STATUS_OK definiert den Ergebnisstatus, wenn die Mitgliedsnummer in Ordnung ist.
static int ERROR_STATUS_UVT_UNKNOWN
          Das Feld ERROR_STATUS_UVT_UNKNOWN definiert den Ergebnisstatus, wenn der UV-Träger unbekannt ist.
static int ERROR_STATUS_WRONG_CHARS
          Das Feld ERROR_STATUS_WRONG_CHARS definiert den Ergebnisstatus, wenn die Mitgliedsnummer unzulässige Zeichen enthält.
static int ERROR_STATUS_WRONG_CHECK_DIGIT
          Das Feld ERROR_STATUS_WRONG_CHECK_DIGIT definiert den Ergebnisstatus, wenn die Mitgliedsnummer eine falsche Prüfziffer hat.
static int ERROR_STATUS_WRONG_FORMAT
          Das Feld ERROR_STATUS_WRONG_FORMAT definiert den Ergebnisstatus, wenn die Mitgliedsnummer das falsche Format hat.
static int ERROR_STATUS_WRONG_LENGTH
          Das Feld ERROR_STATUS_WRONG_LENGTH definiert den Ergebnisstatus, wenn die Mitgliedsnummer eine falsche Länge hat.
 
Method Summary
 int getDefinedAccuracy()
          Die vorgegebene Prüfgenauigkeit.
 int getErrorStatus()
          Liefert den Fehlerstatus der durchgeführten Mitgliedsnummerprüfung.
 java.lang.String getErrorText()
          Liefert den Fehlerstatus der durchgeführten Mitgliedsnummerprüfung, wenn der Status nicht 0 ist.
 java.lang.String getPlausiVersion()
          Liefert die für die Prüfung verwendete PL-Version.
 int getUsedAccuracy()
          Die verwendete Prüfgenauigkeit.
 

Field Detail

ERROR_STATUS_NO_CHECK

static final int ERROR_STATUS_NO_CHECK
Das Feld ERROR_STATUS_NO_CHECK definiert den Ergebnisstatus, wenn keine Prüfung durchgeführt wurde.

See Also:
Constant Field Values

ERROR_STATUS_OK

static final int ERROR_STATUS_OK
Das Feld ERROR_STATUS_OK definiert den Ergebnisstatus, wenn die Mitgliedsnummer in Ordnung ist.

See Also:
Constant Field Values

ERROR_STATUS_WRONG_CHARS

static final int ERROR_STATUS_WRONG_CHARS
Das Feld ERROR_STATUS_WRONG_CHARS definiert den Ergebnisstatus, wenn die Mitgliedsnummer unzulässige Zeichen enthält.

See Also:
Constant Field Values

ERROR_STATUS_WRONG_LENGTH

static final int ERROR_STATUS_WRONG_LENGTH
Das Feld ERROR_STATUS_WRONG_LENGTH definiert den Ergebnisstatus, wenn die Mitgliedsnummer eine falsche Länge hat.

See Also:
Constant Field Values

ERROR_STATUS_WRONG_FORMAT

static final int ERROR_STATUS_WRONG_FORMAT
Das Feld ERROR_STATUS_WRONG_FORMAT definiert den Ergebnisstatus, wenn die Mitgliedsnummer das falsche Format hat.

See Also:
Constant Field Values

ERROR_STATUS_WRONG_CHECK_DIGIT

static final int ERROR_STATUS_WRONG_CHECK_DIGIT
Das Feld ERROR_STATUS_WRONG_CHECK_DIGIT definiert den Ergebnisstatus, wenn die Mitgliedsnummer eine falsche Prüfziffer hat.

See Also:
Constant Field Values

ERROR_STATUS_UVT_UNKNOWN

static final int ERROR_STATUS_UVT_UNKNOWN
Das Feld ERROR_STATUS_UVT_UNKNOWN definiert den Ergebnisstatus, wenn der UV-Träger unbekannt ist.

See Also:
Constant Field Values

CHECK_ACCURACY_LENGTH_AND_CHARS

static final int CHECK_ACCURACY_LENGTH_AND_CHARS
Das Feld CHECK_ACCURACY_LENGTH_AND_CHARS definiert den Prüfgenauigkeit, wenn nur Länge und zulässige Zeichen geprüft werden.

See Also:
Constant Field Values

CHECK_ACCURACY_FULL

static final int CHECK_ACCURACY_FULL
Das Feld CHECK_ACCURACY_FULL definiert den Prüfgenauigkeit, wenn eine komplette Prüfung der Mitgliedsnummer mit Formatierung und Prüfziffern durchgeführt wird.

See Also:
Constant Field Values

CHECK_ACCURACY_AGAINST_STOCK

static final int CHECK_ACCURACY_AGAINST_STOCK
Das Feld CHECK_ACCURACY_AGAINST_STOCK definiert den Prüfgenauigkeit, wenn die Mitgliedsnummer gegen den Bestand geprüft wird.

See Also:
Constant Field Values
Method Detail

getErrorStatus

int getErrorStatus()
Liefert den Fehlerstatus der durchgeführten Mitgliedsnummerprüfung. -1 = keine Prüfung durchgeführt 0 = OK 1 = unzulässige Zeichen 2 = falsche Länge 3 = falsche Formatierung 4 = falsche Prüfziffer 5 = unbekannter UV-Träger

Returns:
der Fehlerstatus

getErrorText

java.lang.String getErrorText()
Liefert den Fehlerstatus der durchgeführten Mitgliedsnummerprüfung, wenn der Status nicht 0 ist.

Returns:
der Fehlertext

getDefinedAccuracy

int getDefinedAccuracy()
Die vorgegebene Prüfgenauigkeit. 1 = nur Länge und zulässige Zeichen 2 = vollständige Prüfung (auch Formatierung, Prüfziffern) 3 = Prüfung gegen Bestand (für spätere Erweiterungen)

Returns:
vorgegebene Prüfgenauigkeit

getUsedAccuracy

int getUsedAccuracy()
Die verwendete Prüfgenauigkeit. 1 = nur Länge und zulässige Zeichen 2 = vollständige Prüfung (auch Formatierung, Prüfziffern) 3 = Prüfung gegen Bestand (für spätere Erweiterungen)

Returns:
verwendete Prüfgenauigkeit

getPlausiVersion

java.lang.String getPlausiVersion()
Liefert die für die Prüfung verwendete PL-Version.

Returns:
die verwendete PL-Version