Vor Beginn Statusverarbeitung

Inhalt [ Verbergen ]

Schnittstelle: IPluginFormPreProcess

Verwendungsmöglichkeiten

Möglichkeit zum Einbau einer individuellen Prüfung, welche nach dem Abspeichern der Formulardaten in der Datenbank, aber vor Beginn der Statusverarbeitung durchgeführt werden kann.

Damit könnte zum Beispiel bewirkt werden, dass die Verarbeitung von Formulardaten innerhalb der Statusverarbeitung umgangen wird, aber die eingegeben Formulardaten trotzdem in der Datenbank abgespeichert werden.

Bei Verwendung mehrerer Formular-PreProcess-Implementierungen ist die Reihenfolge nicht fest, in der diese ausgeführt werden. Die Reihenfolge kann daher jedesmal anders sein.

Die Formular-PreProcess-Implementierungen werden grundsätzlich vor jedem Formularaufruf im jeweiligen Anwendungsbereich (System- oder Mandant-Plugin), in dem sie installiert wurden, ausgeführt. Es wird deshalb empfohlen, in der Implementierungslogik als erstes zu prüfen, ob die PreProcess-Implementierung für die jeweilige Formularverarbeitung ausgeführt werden soll. Dies lässt sich beispielsweise mittels Einsatz von Plugin-Properties konfigurierbar gestalten.

Einordnung des PreProcess-Plugins in die Prozesskette von Xima® Formcycle

Methodensignaturen

IPluginFormPreProcessRetVal execute(IPluginFormPreProcessParams params) throws FCPluginException

Übergabewert

Der Typ IPluginFormPreProcessParams stellt den Zugriff auf folgende Eigenschaften bereit:

  • aktuelles Projekt
  • aktueller Vorgang
  • aktuelle Version des Formulars mit dem Zugriff auf alle enthaltenen Formularelemente
  • Sessionparameter
  • aktueller Nutzerkontext um beispielsweise Datenbankoperationen ausführen zu können

Rückgabewerte

Der Rückgabewert muss vom Typ IPluginFormPreProcessRetVal sein. Eine Referenzimplementierung wird durch die Klasse PluginGenericFormProcessingRetVal bereitgestellt.

Bei der Instanziierung eines entsprechenden Objektes wird eine boolsche Flagge erwartet. Hat diese den Wert true, wird die weitere Verarbeitung in Xima® Formcycle fortgesetzt. Bei false wird die Verarbeitung abgebrochen.