Package org.nuxeo.ecm.automation

Interface OperationType

All Known Implementing Classes:
AbstractOperationType, ChainTypeImpl, OperationTypeImpl, ScriptingOperationTypeImpl
public interface OperationType
Describe an operation class. Each registered operation will be stored in the registry as an instance of this class.
Author:
Bogdan Stefanescu

  • Method Details

    • getId

      String getId()

    • getAliases

      String[] getAliases()
      The operation ID Aliases array.
      Since:
      7.1

    • isEnabled

      boolean isEnabled()
      Since:
      2021.17

    • getType

      Class<?> getType()
      Returns:
      the type of the current object

    • getInputType

      default String getInputType()
      The input type of a chain/operation. If set, the following input types {"document", "documents", "blob", "blobs"} for all 'run method(s)' will handled. Other values will be adapted as java.lang.Object. If not set, Automation will set the input type(s) as the 'run methods(s)' parameter types (by introspection).
      Since:
      7.4

    • getDocumentation

      OperationDocumentation getDocumentation() throws OperationException
      Throws:
      OperationException

    • getContributingComponent

      String getContributingComponent()
      Gets the name of the component that contributed the operation.

    • getMethodsMatchingInput

      InvokableMethod[] getMethodsMatchingInput(Class<?> in)

    • getMethods

      List<InvokableMethod> getMethods()
      Since:
      5.7.2

    • newInstance

      Object newInstance(OperationContext ctx, Map<String,Object> args) throws OperationException
      Throws:
      OperationException