Package ch.ivyteam.ivy.bpm.exec

Interface IBpmnProcessElement

public interface IBpmnProcessElement
Extension point interface to provide the execution part of an 3rd party Ivy process element.

3rd party providers can implement this interface to provide an ivy extension for defining their own process elements based on the process elements:

  • Program Interface
  • Start Event
  • Intermediate Event
  • Call & Wait
Since:
9.2.0
API:
This is a public API.

  • Method Details

    • getExecutor

      Class<? extends IUserProcessExtension> getExecutor()
      Specifies an executor class. Its method perform() will be run during execution.
      Returns:
      The executor class used for this 3rd party process element.
      Since:
      9.2.0
      API:
      This public API is available in Java.

    • getName

      String getName()
      Returns the name of the 3rd party process element.
      Returns:
      The name of this process element.
      Since:
      9.2.0
      API:
      This public API is available in Java.

    • getValidator

      default Class<? extends ch.ivyteam.ivy.process.validate.ElementValidator> getValidator()
      Specifies the process element validator class of this process element.

      The implementation of this method is optional. The default implementation does not specify a validator.

      Returns:
      The element validator class or null.
      Since:
      9.2.0
      API:
      This public API is available in Java.

    • getProcessKinds

      default EnumSet<ch.ivyteam.ivy.components.ProcessKind> getProcessKinds()
      Specifies the process kinds in which the process element class entry is allowed.

      The implementation of this method is optional. The default implementation allows the process element in all process kinds.

      Returns:
      A set of process kinds the process element is allowed in.
      Since:
      9.2.0
      API:
      This public API is available in Java.

    • getKind

      default IBpmnProcessElement.ElementKind getKind()
      Specifies the type of 3rd party process element is implemented. See IBpmnProcessElement.ElementKind about what types are defined.^
      Returns:
      The type of this process element.
      Since:
      9.2.0
      API:
      This public API is available in Java.

    • getIconId

      default String getIconId()
      Since:
      9.4.0
      API:
      This public API is available in Java.

    • getShortLabel

      default String getShortLabel()
      Since:
      9.4.0
      API:
      This public API is available in Java.

    • getLabel

      default String getLabel()
      Since:
      9.4.0
      API:
      This public API is available in Java.

    • getDescription

      default String getDescription()
      Since:
      9.4.0
      API:
      This public API is available in Java.

    • getElementGroup

      default String getElementGroup()
      Since:
      9.4.0
      API:
      This public API is available in Java.