X4 Produktdokumentation

Adapter-Operationen festlegen

Adapter bieten bestimmte Funktionen, die sich im X4 Designer in der Properties-Sicht über die Eigenschaft Operation auswählen lassen. Jeder Listeneintrag dieses Auswahlmenüs entspricht einer Operation-Methode im Adapter.

Ein Adapter benötigt mindestens eine Operation. Verfügt der Adapter nur über eine einzige Operation, so wird diese im Prozess-Designer automatisch ausgewählt.

Methoden zu Operationen zuordnen

  1. Für jede Operation die Annotation @AdapterOperation für die Deklaration an eine public-Methode in der Adapter-Klasse angeben.

  2. Parameter definieren.

    • Jede Methode kann optional einen Parameter definieren. Dieser entspricht dem Adapter-Input. 

    • Der Rückgabetyp der Methode kann X4Document oder eine JAXB-konforme Java-Bean sein. Ist der Rückgabetyp void, wird der Input als Output betrachtet.

    • Um Java-Beans benutzen zu können, muss der Input XML und konform zur Java-Bean-Definition sein. Andernfalls wird die Adapter-Ausführung mit dem Status -1 abgebrochen. 

    Das Grundgerüst einer Operation-Methode ist nun fertig.

Metadaten für  Adapter-Operation definieren

Um Metadaten für Adapter-Operationen zu definieren, wird die Annotation  @AdapterOperation  verwendet:

Feld

Beschreibung

name

Gibt den Namen der Operation an und kann frei gewählt werden. Er muss jedoch eindeutig pro Adapter sein.