Package com.axelor.workflow.plan

Record Class WorkflowPlan.SendStep

java.lang.Object
java.lang.Record
com.axelor.workflow.plan.WorkflowPlan.SendStep
All Implemented Interfaces:
WorkflowPlan.Step
Enclosing class:
WorkflowPlan
public static record WorkflowPlan.SendStep(String id, String message, String signal, String key, String payload, Integer ttl, MessageExpect expect, String next) extends Record implements WorkflowPlan.Step
A compiled <send>: a message (name and key) or a signal (name alone), and where the walk goes next. It carries no boundaries, since it neither waits nor runs author code.

  • Constructor Details

    • SendStep

      public SendStep(String id, String message, String signal, String key, String payload, Integer ttl, MessageExpect expect, String next)
      Creates an instance of a SendStep record class.
      Parameters:
      id - the value for the id record component
      message - the value for the message record component
      signal - the value for the signal record component
      key - the value for the key record component
      payload - the value for the payload record component
      ttl - the value for the ttl record component
      expect - the value for the expect record component
      next - the value for the next record component

  • Method Details

    • type

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

    • broadcast

      public boolean broadcast()
      Whether this broadcasts a signal rather than addressing a message by key.

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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

    • message

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

    • signal

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

    • key

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

    • payload

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

    • ttl

      public Integer ttl()
      Returns the value of the ttl record component.
      Returns:
      the value of the ttl record component

    • expect

      public MessageExpect expect()
      Returns the value of the expect record component.
      Returns:
      the value of the expect record component

    • next

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