Record Class Procedure

java.lang.Object
java.lang.Record
com.axelor.ai.procedure.Procedure
Record Components:
name - the procedure's name, unique within its skill
title - shown to the model and in approvals
description - more for the model, or null
action - the action-view that gives the model, the form and the context
view - the view type it runs in; form only, for now
isNew - whether it runs on a new record, taking no id
when - a guard evaluated on the loaded record before any step, or null
inputs - the only values the model supplies, by name, read as inputs.<name>
steps - run in order
interactions - answers to alerts no one can answer, by "<action>: <message>"

public record Procedure(String name, String title, String description, String action, String view, boolean isNew, String when, Map<String,Procedure.Input> inputs, List<Procedure.Step> steps, Map<String,Procedure.Policy> interactions) extends Record
A named, reviewed run of a form's own steps, carried by a skill: open the action-view's form on a record (or a new one), set fields, click buttons, save — each step handled as the web client would. The model only names the procedure and fills its inputs; it never supplies steps.
  • Field Details

    • EVAL

      public static final String EVAL
      The prefix of a value or guard evaluated on the server, as in action-record.
      See Also:
  • Constructor Details

  • Method Details

    • 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.
    • name

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

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

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • action

      public String action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component
    • view

      public String view()
      Returns the value of the view record component.
      Returns:
      the value of the view record component
    • isNew

      public boolean isNew()
      Returns the value of the isNew record component.
      Returns:
      the value of the isNew record component
    • when

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

      public Map<String,Procedure.Input> inputs()
      Returns the value of the inputs record component.
      Returns:
      the value of the inputs record component
    • steps

      public List<Procedure.Step> steps()
      Returns the value of the steps record component.
      Returns:
      the value of the steps record component
    • interactions

      public Map<String,Procedure.Policy> interactions()
      Returns the value of the interactions record component.
      Returns:
      the value of the interactions record component