Package com.axelor.workflow.plan

Record Class WorkflowPlan.EndStep

java.lang.Object
java.lang.Record
com.axelor.workflow.plan.WorkflowPlan.EndStep
Record Components:
terminate - whether reaching it stops the whole run, not just this path
error - ends the run failed under this name instead of completed
All Implemented Interfaces:
WorkflowPlan.Step
Enclosing class:
WorkflowPlan
public static record WorkflowPlan.EndStep(String id, boolean terminate, String error) extends Record implements WorkflowPlan.Step
The walk stops here.

  • Constructor Details

    • EndStep

      public EndStep(String id, boolean terminate, String error)
      Creates an instance of a EndStep record class.
      Parameters:
      id - the value for the id record component
      terminate - the value for the terminate record component
      error - the value for the error record component

  • Method Details

    • type

      public String type()
      Specified by:
      type in interface WorkflowPlan.Step

    • targets

      public List<String> targets()
      Specified by:
      targets in interface WorkflowPlan.Step

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public String id()
      Returns the value of the id record component.
      Specified by:
      id in interface WorkflowPlan.Step
      Returns:
      the value of the id record component

    • terminate

      public boolean terminate()
      Returns the value of the terminate record component.
      Returns:
      the value of the terminate record component

    • error

      public String error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component