Vor Beginn Response-Erstellung

Inhalt [ Verbergen ]

Schnittstelle IPluginFormPreRespond

Verwendungsmöglichkeiten

  • Auslieferung einer leeren Seite
  • Auslieferung des Response an ein anderes System

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

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

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

Methodensignaturen

IPluginFormPreRespondRetVal execute(IPluginFormPreRespondParams params) throws FCPluginException

Übergabewert

Der Typ IPluginFormPreRespondParams stellt den Zugriff auf folgende Eigenschaften bereit:

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

Rückgabewerte

Der Rückgabewert muss vom Typ IPluginFormPreRespondRetVal sein. Eine Referenzimplementierung wird durch die Klasse PluginGenericFormProcessingRetVal bereitgestellt,
welche bei der Initialisierung eine boolsche Flagge erwartet. Hat diese den Wert true, wird die weitere Verarbeitung in Xima® Formcycle fortgesetzt. Bei false wird die Verarbeitung abgebrochen.