Class ScriptingOperationDescriptor

java.lang.Object
org.nuxeo.automation.scripting.internals.ScriptingOperationDescriptor
All Implemented Interfaces:
OperationDescriptor, Descriptor

public class ScriptingOperationDescriptor extends Object implements OperationDescriptor
Since:
7.2
  • Field Details

    • id

      protected String id
    • enabled

      protected boolean enabled
    • inputType

      protected String inputType
    • outputType

      protected String outputType
    • description

      protected String description
    • category

      protected String category
    • aliases

      protected String[] aliases
    • params

      protected OperationDocumentation.Param[] params
    • source

      protected String source
    • contributingComponent

      protected ComponentInstance contributingComponent
      Since:
      11.1
  • Constructor Details

    • ScriptingOperationDescriptor

      public ScriptingOperationDescriptor()
  • Method Details

    • getId

      public String getId()
      Description copied from interface: Descriptor
      The descriptor id, descriptors with same id are merged.

      To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

      To forbid merge use a unique value, non-overriden toString() for exemple.

      Specified by:
      getId in interface Descriptor
    • getAliases

      public String[] getAliases()
    • getInputType

      public String getInputType()
    • getOutputType

      public String getOutputType()
    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface OperationDescriptor
      Returns:
      whether this operation is enabled or not
      Since:
      2021.17
    • replace

      public boolean replace()
      Specified by:
      replace in interface OperationDescriptor
      Returns:
      whether this operation replaces an existing one
      Since:
      2025.0
    • getDescription

      public String getDescription()
    • getCategory

      public String getCategory()
    • getParams

      public OperationDocumentation.Param[] getParams()
    • getContributingComponent

      public String getContributingComponent()
      Since:
      11.1
    • toType

      public OperationType toType()
      Specified by:
      toType in interface OperationDescriptor
      Returns:
      the OperationType for this descriptor
      Since:
      2025.0
    • toString

      public String toString()
      Overrides:
      toString in class Object