Package org.nuxeo.ecm.automation.core.annotations

Annotation Type Operation

  • @Retention(RUNTIME)
@Target(TYPE)
public @interface Operation
    Marks a class as being an operation.

    An operation may provide an ID as the annotation value. If no id is specified the class name will be used as the ID.

    The ID is the key used to register the operation.

    Make sure you choose a proper ID name to avoid collisions (using the default: ID the class name can be a solution).

    Author:
    Bogdan Stefanescu

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean addToStudio
      Boolean indicating if this operation should be exposed in Studio (optional), defaults to true.
      String[] aliases
      ID Aliases array for a given operation.
      String category
      The operation category (optional), useful for documentation.
      String deprecatedSince
      Nuxeo version from which this operation is deprecated (optional), useful for documentation.
      String description
      Description of this operation (optional), useful for documentation.
      String id
      The operation ID (mandatory).
      String label
      The operation label (optional), useful for documentation.
      String requires
      Name of the context requires by this operation (optional), useful for documentation.
      String since
      Nuxeo version from which this operation is available (optional), useful for documentation.

    • Element Detail

      • id

        String id
        The operation ID (mandatory).

        If not specified the absolute name of the annotated class will be used.

        Default:
        ""

      • category

        String category
        The operation category (optional), useful for documentation.

        Provide a category to be used by the UI to classify the operations (on the documentation page or in Studio).

        Default:
        "Others"

      • label

        String label
        The operation label (optional), useful for documentation.

        Provide a label for the operation to be used in UI (should not contain any HTML code).

        Default:
        ""

      • requires

        String requires
        Name of the context requires by this operation (optional), useful for documentation.

        Provide the name of the context required by this operation. Example: event, ui, wf, etc..

        Default:
        ""

      • description

        String description
        Description of this operation (optional), useful for documentation.

        Provide a description of the operation (may contain HTML code).

        Default:
        ""

      • since

        String since
        Nuxeo version from which this operation is available (optional), useful for documentation.

        The default value is the null string "" which means no specific version is required. Examples: "5.4", "5.9.1".

        Default:
        ""

      • deprecatedSince

        String deprecatedSince
        Nuxeo version from which this operation is deprecated (optional), useful for documentation.

        The default value is the null string "" which means no specific version. Examples: "5.4", "5.9.1".

        Since:
        5.9.1
        Default:
        ""

      • addToStudio

        boolean addToStudio
        Boolean indicating if this operation should be exposed in Studio (optional), defaults to true.

        This is convenient helper for Studio operations export.

        Since:
        5.9.1
        Default:
        true

      • aliases

        String[] aliases
        ID Aliases array for a given operation.
        Since:
        7.1
        Default:
        {}