Wiki-Quellcode von Datenquelle
Verstecke letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1.1 | 1 | {{content/}} | |
2 | |||
3 | {{info}} | ||
4 | Nach Installation des Plugins kann dieses über den {{designer case="acc"/}} direkt am jeweiligen Auswahlfeld zugeordnet werden. | ||
5 | {{/info}} | ||
6 | |||
4.2 | 7 | **[[Download Demo-Projekt für diesen Plugin-Typ>>url:https://customer.formcycle.eu/index.php/s/NbIQQqDEzt58Qju||rel="noopener noreferrer" target="_blank"]]** | |
8 | |||
1.1 | 9 | == Schnittstelle: IPluginDataSource == | |
10 | |||
11 | === Verwendungsmöglichkeiten === | ||
12 | |||
4.1 | 13 | {{figure image="plugin_datasource.png" width="500" clear="h2"}} | |
1.1 | 14 | Einordnung des Plugins für Datenquellen in die {{formcycle/}} Prozesskette. | |
15 | {{/figure}} | ||
16 | |||
4.1 | 17 | * Bereitstellen von Daten für Formular-Auswahlfelder | |
18 | |||
2.3 | 19 | == Methodesignaturen == | |
1.1 | 20 | ||
2.3 | 21 | Die Plugin-Schnittstelle IPluginDataSource referenziert alle durch die [[Basis-Schnittstelle IFCPlugin>>doc:IFCPlugin]] bereitgestellten Methoden | |
22 | und zusätzlich noch folgende Plugin-spezifische Methodensignaturen: | ||
23 | |||
4.1 | 24 | {{panel title="{{code language='java'~}~}IPluginDataSourceRetVal resolve(IPluginDataSourceParams params) throws FCPluginException{{/code~}~}" triggerable="true" fullwidth="true"}} | |
3.1 | 25 | ((( | |
2.4 | 26 | Methode zum Auflösen einer Datenquelle. | |
3.1 | 27 | ))) | |
28 | ((( | ||
29 | **Übergabewerte:** | ||
1.1 | 30 | ||
4.1 | 31 | * Der Typ //IPluginDataSourceParams// stellt folgende Eigenschaften bereit: | |
2.4 | 32 | ** **getProjekt:** das Projekt welches das Formular bereitstellt | |
33 | ** **getMandant():** der Mandant in welchem sich das Formular befindet | ||
34 | ** **getSessionAttributeMap():** eine Map mit allen in der Session serialisierbaren Attributen | ||
35 | ** **getRequestParameters():** Liefert ein Objekt mit aufbereiteten Request-Parametern, welche je nach Typ in entsprechende Listen einsortiert sind | ||
3.1 | 36 | ))) | |
37 | **Rückgabewerte:** | ||
38 | ((( | ||
4.1 | 39 | Rückgabewerte müssen vom Typ //IPluginDataSourceRetVal// sein, eine Referenz-Implementierung wird durch die Klasse //PluginDataSourceRetVal// bereitgestellt. | |
3.1 | 40 | ))) | |
4.1 | 41 | Im Objekt-Konstruktor kann ein serialisierbares JSON-Arrays übergeben werden, dessen Werte nach Auslieferung des Formulars an den Browser, im entsprechenden Auswahlfeld zugeordnet sind. | |
42 | In den einzelnen JSON-Objekten des Arrays werden folgende Werte erwartet: | ||
43 | * **text:** für den anzuzeigenden Text eines Auswahl-Elementes | ||
44 | * **value:** für den zu übertragenen Wert (beim Absenden des Formulars) eines Auswahl-Elementes | ||
45 | |||
46 | |||
47 | Ist zusätzlich der Eintrag **title** vorhanden, wird dieser als Wert für das title-Attribut der Auswahl-Option verwendet. | ||
48 | <br><br> | ||
2.4 | 49 | Bei fehlerhafter Abarbeitung des Plugins wird eine **FCPluginException** geworfen. | |
2.5 | 50 | ||
3.1 | 51 | {{/panel}} |