Package io.jmix.dynmodelai.agent.tool

Record Class ToolResult

java.lang.Object

java.lang.Record

io.jmix.dynmodelai.agent.tool.ToolResult

public record ToolResult(ToolOutcome outcome, String code, String message)
extends Record

Stable deterministic result understood by the Engine.

Constructor Summary

Constructors

Constructor	Description
ToolResult(ToolOutcome outcome, String code, String message)	Creates an instance of a ToolResult record class.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the value of the code record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ToolResult	failed(String code, String message)
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
ToolOutcome	outcome()	Returns the value of the outcome record component.
static ToolResult	runClosed(String message)
boolean	succeeded()
static ToolResult	succeeded(String message)
final String	toString()	Returns a string representation of this record class.
static ToolResult	validationFailed(String code, String message)

Methods inherited from class java.lang.Object

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

Constructor Details

ToolResult

public ToolResult(ToolOutcome outcome,
 String code,
 String message)

Creates an instance of a ToolResult record class.

Parameters:

outcome - the value for the outcome record component

code - the value for the code record component

message - the value for the message record component

Method Details

succeeded

public boolean succeeded()

succeeded

public static ToolResult succeeded(String message)

validationFailed

public static ToolResult validationFailed(String code,
 String message)

runClosed

public static ToolResult runClosed(String message)

failed

public static ToolResult failed(String code,
 String message)

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.

outcome

public ToolOutcome outcome()

Returns the value of the outcome record component.

Returns:

the value of the outcome record component

code

public String code()

Returns the value of the code record component.

Returns:

the value of the code record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component