Package com.axelor.ai.procedure
Record Class Procedure
java.lang.Object
java.lang.Record
com.axelor.ai.procedure.Procedure
- Record Components:
name- the procedure's name, unique within its skilltitle- shown to the model and in approvalsdescription- more for the model, or nullaction- the action-view that gives the model, the form and the contextview- the view type it runs in;formonly, for nowisNew- whether it runs on a new record, taking no idwhen- a guard evaluated on the loaded record before any step, or nullinputs- the only values the model supplies, by name, read asinputs.<name>steps- run in orderinteractions- 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordA value the model supplies.static enumHow an alert is answered when no one can answer it.static interfaceOne step of a procedure: what a user does on the form or on a line of it.static enum -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionProcedure(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) Creates an instance of aProcedurerecord class. -
Method Summary
Modifier and TypeMethodDescriptionaction()Returns the value of theactionrecord component.Returns the value of thedescriptionrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.inputs()Returns the value of theinputsrecord component.Returns the value of theinteractionsrecord component.booleanisNew()Returns the value of theisNewrecord component.name()Returns the value of thenamerecord component.steps()Returns the value of thestepsrecord component.title()Returns the value of thetitlerecord component.final StringtoString()Returns a string representation of this record class.view()Returns the value of theviewrecord component.when()Returns the value of thewhenrecord component.
-
Field Details
-
EVAL
The prefix of a value or guard evaluated on the server, as inaction-record.- See Also:
-
-
Constructor Details
-
Procedure
public 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) Creates an instance of aProcedurerecord class.- Parameters:
name- the value for thenamerecord componenttitle- the value for thetitlerecord componentdescription- the value for thedescriptionrecord componentaction- the value for theactionrecord componentview- the value for theviewrecord componentisNew- the value for theisNewrecord componentwhen- the value for thewhenrecord componentinputs- the value for theinputsrecord componentsteps- the value for thestepsrecord componentinteractions- the value for theinteractionsrecord component
-
-
Method Details
-
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. -
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. -
equals
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 withObjects::equals(Object,Object); primitive components are compared with '=='. -
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
title
Returns the value of thetitlerecord component.- Returns:
- the value of the
titlerecord component
-
description
Returns the value of thedescriptionrecord component.- Returns:
- the value of the
descriptionrecord component
-
action
Returns the value of theactionrecord component.- Returns:
- the value of the
actionrecord component
-
view
Returns the value of theviewrecord component.- Returns:
- the value of the
viewrecord component
-
isNew
public boolean isNew()Returns the value of theisNewrecord component.- Returns:
- the value of the
isNewrecord component
-
when
Returns the value of thewhenrecord component.- Returns:
- the value of the
whenrecord component
-
inputs
Returns the value of theinputsrecord component.- Returns:
- the value of the
inputsrecord component
-
steps
Returns the value of thestepsrecord component.- Returns:
- the value of the
stepsrecord component
-
interactions
Returns the value of theinteractionsrecord component.- Returns:
- the value of the
interactionsrecord component
-