Package com.axelor.ai.tool.data

Class SearchRecordsTool

java.lang.Object

com.axelor.ai.tool.system.ModelAwareSystemTool<SearchRecordsTool.Input>

com.axelor.ai.tool.data.SearchRecordsTool

All Implemented Interfaces:

SystemTool<SearchRecordsTool.Input>

public class SearchRecordsTool
extends ModelAwareSystemTool<SearchRecordsTool.Input>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SearchRecordsTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Constructor Summary

Constructors

Constructor	Description
SearchRecordsTool()

Method Summary

Modifier and Type	Method	Description
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
protected ToolResult	executeForJsonModel(SearchRecordsTool.Input input, MetaJsonModel jsonModel, Access access)	Subclass hook — called for a custom model once it is allowed.
protected ToolResult	executeForModel(SearchRecordsTool.Input input, Class<? extends Model> modelClass, Access access)	Searches an entity through the query engine — the same engine query_records and saved queries run on.
Class<SearchRecordsTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.
protected Operation	operation()	The operation this tool performs, which the model's permissions are checked for.
ToolSafety	safety()	Safety classification for approval decisions.

Methods inherited from class com.axelor.ai.tool.system.ModelAwareSystemTool

beforeApproval, checkForJsonModel, checkForModel, customFieldsByName, entityCustomFieldNames, entityCustomFields, entityFieldNames, execute, extractCustomFields, invalidChoice, invalidJsonValues, invalidValues, jsonFieldNames, jsonModelFields, jsonPropertyOf, parseAttrs, saveRecord, selectionOptions, selectionOptions, serializeAttrs, unknownFields, unknownFieldsMessage, unknownJsonFields, validateFields, validateJsonFields

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

callTitle, provideContext, refusal, runsOutsideTransaction, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Constructor Details

SearchRecordsTool

public SearchRecordsTool()

Method Details

operation

protected Operation operation()

Description copied from class: ModelAwareSystemTool

The operation this tool performs, which the model's permissions are checked for.

Specified by:

operation in class ModelAwareSystemTool<SearchRecordsTool.Input>

safety

public ToolSafety safety()

Description copied from interface: SystemTool

Safety classification for approval decisions. Tools default to ToolSafety.WRITE. Override to ToolSafety.READ_ONLY for safe tools that never require approval or ToolSafety.DESTRUCTIVE for tools that should always require approval.

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

name

public String name()

Description copied from interface: SystemTool

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

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

inputType

public Class<SearchRecordsTool.Input> inputType()

Description copied from interface: SystemTool

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

executeForModel

protected ToolResult executeForModel(SearchRecordsTool.Input input,
 Class<? extends Model> modelClass,
 Access access)

Searches an entity through the query engine — the same engine query_records and saved queries run on. That is what lets fields name a dotted path (customer.fullName) and a custom field added to the entity, each checked against the user's field permissions and read in one query, joins included.

Specified by:

executeForModel in class ModelAwareSystemTool<SearchRecordsTool.Input>

Parameters:

access - what the call may do; the tool asks it about every record and field it touches, and may throw AccessDenied from anywhere to refuse the call

executeForJsonModel

protected ToolResult executeForJsonModel(SearchRecordsTool.Input input,
 MetaJsonModel jsonModel,
 Access access)

Description copied from class: ModelAwareSystemTool

Subclass hook — called for a custom model once it is allowed.

Specified by:

executeForJsonModel in class ModelAwareSystemTool<SearchRecordsTool.Input>