Plugin-Typen - Datenquelle

Page / - zuletzt bearbeitet von awa am 28.06.2019, 14:43

Datenquelle

zuletzt bearbeitet von awa

am 28.06.2019, 14:43

Inhaltsverzeichnis

Schnittstelle: IPluginDataSource

Verwendungsmöglichkeiten

Methodesignaturen

Inhalt [ Verbergen ]

Schnittstelle: IPluginDataSource

Verwendungsmöglichkeiten

Methodesignaturen

Nach Installation des Plugins kann dieses über den Xima® Formcycle-Designer direkt am jeweiligen Auswahlfeld zugeordnet werden.

Download Demo-Projekt für diesen Plugin-Typ

Schnittstelle: IPluginDataSource

Verwendungsmöglichkeiten

Einordnung des Plugins für Datenquellen in die Xima® Formcycle Prozesskette.

Bereitstellen von Daten für Formular-Auswahlfelder

Methodesignaturen

Die Plugin-Schnittstelle IPluginDataSource referenziert alle durch die Basis-Schnittstelle IFCPlugin bereitgestellten Methoden
und zusätzlich noch folgende Plugin-spezifische Methodensignaturen:

IPluginDataSourceRetVal resolve(IPluginDataSourceParams params) throws FCPluginException

Methode zum Auflösen einer Datenquelle.

Übergabewerte:

Der Typ IPluginDataSourceParams stellt folgende Eigenschaften bereit:

getProjekt: das Projekt welches das Formular bereitstellt

getMandant(): der Mandant in welchem sich das Formular befindet

getSessionAttributeMap(): eine Map mit allen in der Session serialisierbaren Attributen

getRequestParameters(): Liefert ein Objekt mit aufbereiteten Request-Parametern, welche je nach Typ in entsprechende Listen einsortiert sind

Rückgabewerte:

Rückgabewerte müssen vom Typ IPluginDataSourceRetVal sein, eine Referenz-Implementierung wird durch die Klasse PluginDataSourceRetVal bereitgestellt.

Im Objekt-Konstruktor kann ein serialisierbares JSON-Arrays übergeben werden, dessen Werte nach Auslieferung des Formulars an den Browser, im entsprechenden Auswahlfeld zugeordnet sind. In den einzelnen JSON-Objekten des Arrays werden folgende Werte erwartet:

text: für den anzuzeigenden Text eines Auswahl-Elementes

value: für den zu übertragenen Wert (beim Absenden des Formulars) eines Auswahl-Elementes

Ist zusätzlich der Eintrag title vorhanden, wird dieser als Wert für das title-Attribut der Auswahl-Option verwendet.
Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen.