Statusverarbeitung
Schnittstelle: IPluginProcessing
Verwendungsmöglichkeiten
- Anbindung eigener Webservice-Schnittstellen, die übermittelte Formularwerte weiterverarbeiten sollen
- Anbindung von Fremdsystemen, welche Formularwerte weiterverarbeiten sollen
Methodensignaturen
Die Plugin-Schnittstelle IPluginProcessing referenziert alle durch die Basis-Schnittstelle IFCPlugin bereitgestellten Methoden
und zusätzlich noch folgende Plugin-spezifische Methodensignaturen:
IPluginProcessingRetVal execute(IPluginProcessingParams params) throws FCPluginException
Übergabewerte:
Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen. Auf diese kann in der Statusverarbeitung von Xima® Formcycle, durch Konfiguration einer Aktion, die im Fehlerfall ausgeführt werden soll, reagiert werden.
Der Typ IPluginProcessingParams stellt folgende Eigenschaften bereit:- Zugriff auf den Workflow-Verarbeitungskontext (IWorkflowProcessingContext) und damit auf zentrale Objekt wie:
- aktueller Vorgang
- Formulardaten
- Sessionparameter
- Parameter aus vorgelagerten Aktionsverarbeitungen des gleichen Status
- aktueller Nutzerkontext um beispielsweise Datenbankoperationen ausführen zu können
- Zugriff auf das Aktionsobjekt in welcher die Verarbeitung durchgeführt wird und damit Informationen über die Einordnung der aktuellen Aktion innerhalb der Statusverarbeitung
- Zugriff auf die am Statusverarbeitungs-Plugin konfigurierten Parameter
Interface | Referenzimplementierung | Beschreibung |
---|---|---|
IProcessingResultSuccess | ProcessingResultSuccess | Zurückliefern eines Status (true oder false) |
IProcessingResultIntValue | ProcessingResultIntValue | Rückgabe eines Status und eines Integer-Wertes |
IProcessingResultStringValue | ProcessingResultStringValue | Rückgabe eines Status und eines String-Wertes |
IProcessingResultMultiValue | ProcessingResultMultiValue | Rückgabe eines Status und einer Map mit String-Werten |
IProcessingResultFilePath | ProcessingResultFilePath | Rückgabe eines Status und eines Dateipfades |
IProcessingResultFileData | ProcessingResultFileData | Rückgabe eines Status und den Binärdaten einer Datei |
Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen. Auf diese kann in der Statusverarbeitung von Xima® Formcycle, durch Konfiguration einer Aktion, die im Fehlerfall ausgeführt werden soll, reagiert werden.