Package com.axelor.ai.tool.data

Class SaveQueryTool

java.lang.Object

com.axelor.ai.tool.data.SaveQueryTool

All Implemented Interfaces:

SystemTool<SaveQueryTool.Input>

public class SaveQueryTool
extends Object
implements SystemTool<SaveQueryTool.Input>

Saves a query directly as a reusable MetaQuery record. Use this for ad-hoc analytics queries — not for studio app development (use studio_save_query for that).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SaveQueryTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Constructor Summary

Constructors

Constructor	Description
SaveQueryTool()

Method Summary

Modifier and Type	Method	Description
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
ToolResult	execute(SaveQueryTool.Input input, ToolContext context)	Execute with the given typed input and agent-scoped context.
Class<SaveQueryTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.axelor.ai.tool.system.SystemTool

beforeApproval, callTitle, provideContext, refusal, runsOutsideTransaction, safety, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Constructor Details

SaveQueryTool

public SaveQueryTool()

Method Details

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

Specified by:

code in interface SystemTool<SaveQueryTool.Input>

name

public String name()

Description copied from interface: SystemTool

Human-readable display name (e.g. "Search Records").

Specified by:

name in interface SystemTool<SaveQueryTool.Input>

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

Specified by:

description in interface SystemTool<SaveQueryTool.Input>

inputType

public Class<SaveQueryTool.Input> inputType()

Description copied from interface: SystemTool

The input record class. Return Void.class for tools with no input.

Specified by:

inputType in interface SystemTool<SaveQueryTool.Input>

execute

public ToolResult execute(SaveQueryTool.Input input,
 ToolContext context)

Description copied from interface: SystemTool

Execute with the given typed input and agent-scoped context.

Specified by:

execute in interface SystemTool<SaveQueryTool.Input>