Wiki-Quellcode von Vor Beginn Response-Erstellung
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | {{content/}} | ||
2 | |||
3 | == Schnittstelle IPluginFormPreRespond == | ||
4 | |||
5 | === Verwendungsmöglichkeiten === | ||
6 | |||
7 | * Auslieferung einer leeren Seite | ||
8 | * Auslieferung des Response an ein anderes System | ||
9 | |||
10 | {{warning}} | ||
11 | Bei Verwendung mehrere //Form-PreRespond//-Implementierungen ist die Reihenfolge nicht fest, in der diese ausgeführt werden. Die Reihenfolge kann daher jedesmal anders sein. | ||
12 | {{/warning}} | ||
13 | |||
14 | {{warning}} | ||
15 | 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. | ||
16 | {{/warning}} | ||
17 | |||
18 | {{figure image="plugin_prerespond.png" width="400"}} | ||
19 | Einordnung des //PreRespond//-Plugins in die Prozesskette von {{formcycle case="dat"/}} | ||
20 | {{/figure}} | ||
21 | |||
22 | === Methodensignaturen === | ||
23 | |||
24 | {{code language="java"}} | ||
25 | IPluginFormPreRespondRetVal execute(IPluginFormPreRespondParams params) throws FCPluginException | ||
26 | {{/code}} | ||
27 | |||
28 | == Übergabewert == | ||
29 | |||
30 | Der Typ //IPluginFormPreRespondParams// stellt den Zugriff auf folgende Eigenschaften bereit: | ||
31 | |||
32 | * aktuelles Projekt | ||
33 | * aktueller Vorgang | ||
34 | * aktuelle Version des Formulars mit dem Zugriff auf alle enthaltenen Formularelemente und deren übergebene Werte | ||
35 | * Sessionparameter | ||
36 | * aktueller Nutzerkontext um beispielsweise Datenbankoperationen ausführen zu können | ||
37 | |||
38 | == Rückgabewerte == | ||
39 | |||
40 | Der Rückgabewert muss vom Typ //IPluginFormPreRespondRetVal// sein. Eine Referenzimplementierung wird durch die Klasse //PluginGenericFormProcessingRetVal// bereitgestellt, | ||
41 | welche bei der Initialisierung eine boolsche Flagge erwartet. Hat diese den Wert //true//, wird die weitere Verarbeitung in {{formcycle case="dat"/}} fortgesetzt. Bei //false// wird die Verarbeitung abgebrochen. |