Pre-persist

Geändert am Mo, 9 Jan, 2023 um 3:27 NACHMITTAGS

Schnittstelle: IPluginFormPrePersist

Einordnung des PrePersist-Plugins in die FORMCYCLE Prozesskette.

Verwendungsmöglichkeiten

Bietet eine Möglichkeit zum Einbau einer individuellen Prüfung, ob Daten abgespeichert werden sollen.

Wenn nicht, dann kann ein Abbruch der weiteren Datenverarbeitung an dieser Stelle bewirkt werden.

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

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

Methodensignaturen

IPluginFormPrePersistRetVal execute(IPluginFormPrePersistParams params) throws FCPluginException

Übergabewert:Der Typ IPluginFormPrePersistParams stellt mit der Methode getFormRequestContext() den Zugriff auf die IFormRequestContext-Schnittstelle und damit auf folgende Eigenschaften bereit:

getCurrentBenutzer(): den aktuellen Benutzer
getUserContext(): den aktuellen Nutzerkontext, um beispielsweise Datenbankoperationen ausführen zu können
getProjekt(): das aktuelles Projekt
getMandant(): der aktuelle Mandant
getVorgang(): den aktueller Vorgang
getFormVersion(): die aktuelle Version des Formulars mit dem Zugriff auf alle enthaltenen Formular-Elemente
getLocale(): Informationen zur aktuell gewählte Sprache und Region
getSessionAttributeMap(): eine Map mit den aktuellen Session-Parametern
getFrontendServer(): Zugriff auf das Frontend-Server-Objekt, wenn Aufruf über Frontend-Server

Rückgabewerte:
Der Rückgabewert muss vom Typ IPluginFormPrePersistRetVal sein. Eine Referenzimplementierung wird durch die Klasse PluginGenericFormProcessingRetVal bereitgestellt. Bei der Initialisierung erwartet diese einen boolschen Wert.

true
Die weitere Verarbeitung in FORMCYCLE wird fortgesetzt.
false
Die weitere Verarbeitung in FORMCYCLE wird abgebrochen.