Package com.axelor.workflow.plan

Record Class WorkflowPlan.Boundary

java.lang.Object
java.lang.Record
com.axelor.workflow.plan.WorkflowPlan.Boundary
Enclosing class:
WorkflowPlan
public static record WorkflowPlan.Boundary(String id, EventKind kind, String code, String name, String key, Integer delay, DelayUnit unit, String until, String when, String next, String title, boolean cancels, Integer repeatCount) extends Record
A compiled <boundary>: one way out of its host and where to continue. kind is its trigger: a timer, a condition, a message or signal, or an error. Live park state is kept on the park, not here.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Boundary(String id, EventKind kind, String code, String name, String key, Integer delay, DelayUnit unit, String until, String when, String next, String title, boolean cancels, Integer repeatCount)
    Creates an instance of a Boundary record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    absolute()
    Whether this deadline is an instant named by until, which is stored, rather than a delay.
    boolean
    cancels()
    Returns the value of the cancels record component.
    boolean
    catchesFailure()
    A boundary catching its host's failure: never armed or polled, consulted where the failure is raised.
    String
    code()
    Returns the value of the code record component.
    boolean
    conditional()
    A boundary watching a condition.
    Integer
    delay()
    Returns the value of the delay record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    EventKind.Family
    family()
    This boundary's trigger family; a boundary written without on is read from its attributes.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    id()
    Returns the value of the id record component.
    String
    key()
    Returns the value of the key record component.
    EventKind
    kind()
    Returns the value of the kind record component.
    String
    name()
    Returns the value of the name record component.
    String
    next()
    Returns the value of the next record component.
    int
    occurrenceLimit()
    How many times this boundary may fire: repeatCount, else once.
    Integer
    repeatCount()
    Returns the value of the repeatCount record component.
    boolean
    timed()
     
    String
    title()
    Returns the value of the title record component.
    final String
    toString()
    Returns a string representation of this record class.
    DelayUnit
    unit()
    Returns the value of the unit record component.
    String
    until()
    Returns the value of the until record component.
    String
    when()
    Returns the value of the when record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Boundary

      public Boundary(String id, EventKind kind, String code, String name, String key, Integer delay, DelayUnit unit, String until, String when, String next, String title, boolean cancels, Integer repeatCount)
      Creates an instance of a Boundary record class.
      Parameters:
      id - the value for the id record component
      kind - the value for the kind record component
      code - the value for the code record component
      name - the value for the name record component
      key - the value for the key record component
      delay - the value for the delay record component
      unit - the value for the unit record component
      until - the value for the until record component
      when - the value for the when record component
      next - the value for the next record component
      title - the value for the title record component
      cancels - the value for the cancels record component
      repeatCount - the value for the repeatCount record component

  • Method Details

    • family

      public EventKind.Family family()
      This boundary's trigger family; a boundary written without on is read from its attributes.

    • timed

      public boolean timed()

    • conditional

      public boolean conditional()
      A boundary watching a condition. Not !timed(), since a failure or message boundary is neither.

    • catchesFailure

      public boolean catchesFailure()
      A boundary catching its host's failure: never armed or polled, consulted where the failure is raised.

    • absolute

      public boolean absolute()
      Whether this deadline is an instant named by until, which is stored, rather than a delay.

    • occurrenceLimit

      public int occurrenceLimit()
      How many times this boundary may fire: repeatCount, else once.

    • 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.
      Returns:
      the value of the id record component

    • kind

      public EventKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • code

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

    • name

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

    • key

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

    • delay

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

    • unit

      public DelayUnit unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component

    • until

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

    • when

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

    • next

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

    • title

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

    • cancels

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

    • repeatCount

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