Schnittstelle: IPluginDataSource

Verwendungsmöglichkeiten

• 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:

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

Der Rückgabewert muss vom Typ IPluginDataSourceRetVal sein, eine Referenzimplementierung wird durch die Klasse PluginDataSourceRetVal bereitgestellt.

Das Objekt ermöglicht die Übergabe eines serialisierbaren JSON-Arrays, dessen Werte nach Auslieferung des Formulars an den Browser, im entsprechenden Auswahlfeld zugeordnet sind.
In den einzelnen JSON-Objekten des Arrays wird der Eintrag text für den anzuzeigenden Text und der Eintrag value für den zu persistierenden Wert erwartet (Wert beim Absenden des Formulars). Ist der Eintrag title vorhanden, wird dieser als Wert für das title-Attribut der Auswahloption verwendet.

Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen.