# Übersicht Annotationen

Ein Überblick über die Annotationen, die uns bei der Umsetzung zur Verfügung stehen.

# @Component

package com.elo.flows.api.components.annotations;
public abstract @interface Component {
    public abstract java.lang.String namespace();
    public abstract java.lang.String name();
    public abstract java.lang.String version();
    public abstract java.lang.String displayName();
    public abstract java.lang.String iconUri() default "/assets/icon.png";
    public abstract java.lang.String description() default "";
}

Name	Beschreibung
namespace	Namensraum (Paketierung im Projekt).
name	Name der Komponente.
version	Version der aktuellen Version.
displayName	Anzeigename der in der Flows Administration angezeigt wird.
iconUri	Pfad zum Icon der Komponente, Standard /assets/icon.png.
description	Kurze Beschreibung der Komponente, die nach dem Markieren der Komponente angezeigt wird. Weitere Informationen werden über die Annotation `@Guide` in der Komponente hinterlegt.

# @Service

Die Dienste, die in einer Komponente zur Verfügung gestellt werden.

package com.elo.flows.api.components.annotations;
public abstract @interface Service {
    public abstract java.lang.String name() default "";
    public abstract java.lang.String displayName() default "";
    public abstract java.lang.String description() default "";
}

Name	Beschreibung
name	Name des Dienstes.
displayName	Anzeigename der in der Flows Administration angezeigt wird.
description	Kurze Beschreibung des Dienstes, die nach dem Markieren des Dienstes angezeigt wird. Weitere Informationen werden über die Annotation `@Guide` im Dienst hinterlegt.

# @Trigger, @WebHook

Trigger über den ein Flow gestartet werden kann.

package com.elo.flows.api.components.annotations;
public abstract @interface Trigger {
    public abstract java.lang.String name() default "";
    public abstract java.lang.String displayName() default "";
    public abstract java.lang.String description() default "";
}
package com.elo.flows.api.components.annotations;
    public abstract @interface WebHook {
    public abstract java.lang.String endpoint() default "";
}

Name	Beschreibung @Trigger
name	Name des Triggers.
displayName	Anzeigename der in der Flows Administration angezeigt wird.
description	Kurze Beschreibung des Triggers, der nach dem Markieren des Triggers angezeigt wird. Weitere Informationen werden über die Annotation `@Guide` im Trigger hinterlegt.

Name	Beschreibung @WebHook
endpoint	Bezeichner für den Aufruf.

# @Config

Wird in einem Trigger (Trigger-Methode) als Parameter verwendet. Zeigt an, dass im Trigger im Tab Einstellungen Konfigurationen vorgenommen werden können.

package com.elo.flows.api.components.annotations;
public abstract @interface Config {
}

# @Synchron

Kennzeichnet einen synchronen Trigger.

package com.elo.flows.api.components.annotations;
public abstract @interface Synchron {
  public abstract  java.lang.Class<? extends java.lang.Object>[] resultClasses() default {};
}

# @Guide

Ermöglicht das Anbinden von Informationsdateien im Markdown-Format.

package com.elo.flows.api.components.annotations;
public abstract @interface Guide {
    public abstract java.lang.String value();
}

# @Property

Feld im Tab Einstellungen.

package com.elo.flows.api.schema.annotations;
public abstract @interface Property {
    public abstract java.lang.String displayName() default "";
    public abstract java.lang.String description() default "";
    public abstract boolean required() default false;
}

Name	Beschreibung
displayName	Anzeigename der in der Flows Administration angezeigt wird.
description	Kurze Beschreibung des Eingabefeldes, die hinter dem (i) als Tooltip angezeigt wird.
required	Gibt an, ob es sich um ein Pflichtfeld handelt.

# @DisplayOptions

Weiter Konfigurationsmöglichkeiten der Eingabefelder.

package com.elo.flows.api.schema.annotations;
public abstract @interface DisplayOptions {
    public abstract int size() default (int) 1;
    public abstract int order() default (int) 2147483647;
    public abstract boolean hidden() default false;
    public abstract boolean suggestValue() default false;
}

Name	Beschreibung
size	Größe des Eingabefeldes.
order	Bei mehreren Eingabefeldern in einer Gruppe, kann die Reihenfolge beim Anzeigen festgelegt werden.
hidden	Ein Feld kann als versteckt markiert werden.
suggestValue	Der Wert der @Property Variablen wird automatisch im Eingabefeld übernommen.

# @Lookup

Vorschläge Tab im Eingabefeld. Wird mit der Annotation @Property verwendet. Weiter muss sichergestellt sein, dass über die Annotation @LookupProvider eine Methode implementiert wird, die den Inhalt für die Vorschläge bereitstellt.

package com.elo.flows.api.schema.annotations;
public abstract @interface Lookup {
    public abstract java.lang.String value();
}

# @LookupProvider

Vorschläge im Eingabefeld. Wird in Verbindung mit der Annotation @Lookup verwendet.

package com.elo.flows.api.components.annotations;
public abstract @interface LookupProvider {
    public abstract java.lang.String value();
}

# @Connection

Verbindung zum ELO Indexserver.

package com.elo.flows.api.components.annotations;
public abstract @interface Connection {
    public abstract java.lang.Class<?> provider() default java.lang.Void;
}

# @ConnectionRequired

Wird mit @Connection benutzt, wenn z. B. in einer Methode die Verbindung zum ELO Indexserver genutzt wird.

package com.elo.flows.api.components.annotations;
    public abstract @interface ConnectionRequired {
}

# @PropertyGroups, PropertyGroup, PropertyGroupRef

Die Annotationen werden benutzt, um im Tab Dienste die unterschiedlichen Dienste in Gruppen zusammenzufassen.

package com.elo.flows.api.schema.annotations;
public abstract @interface PropertyGroups {
    public abstract com.elo.flows.api.schema.annotations.PropertyGroup[] value();
}
package com.elo.flows.api.schema.annotations;
public abstract @interface PropertyGroup {
    public abstract java.lang.String displayName();
    public abstract java.lang.String name();
    public abstract boolean collapsed() default false;
    public abstract java.lang.String description() default "";
    public abstract int order() default (int) 2147483647;
}

Name	Beschreibung
displayName	Anzeigename der in der Flows Administration angezeigt wird.
name	Name der Gruppe.
collapsed	Die Gruppe kann beim Auswählen geöffnet sein.
description	Kurze Beschreibung der Gruppe. Wird hinter dem Gruppennamen angezeigt, wenn die Gruppe geöffnet ist.
order	Bei mehreren Einstellungen in der Gruppe, kann die Reihenfolge festgelegt werden.

package com.elo.flows.api.schema.annotations;
public abstract @interface PropertyGroupRef {
    public abstract java.lang.String value();
}

← Übersicht ELO Flows-Komponenten