Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Interface FunctionQuery<RESULT>

Type Parameters:

RESULT - the type of the function result

All Superinterfaces:

ModuleQuery, Query

All Known Implementing Classes:

AutoFunctionQuery

public interface FunctionQuery<RESULT>
extends ModuleQuery

An interface for database function queries.

This interface represents a query that calls a database function. It extends ModuleQuery to inherit common database module functionality while specializing for function calls that return a result.

Implementations of this interface handle the execution of database function calls, including parameter binding and result retrieval.

Method Summary

Modifier and Type	Method	Description
RESULT	getResult()	Returns the result of the function call.

Methods inherited from interface org.seasar.doma.jdbc.query.ModuleQuery

getQualifiedName, getSql, getSqlLogType

Methods inherited from interface org.seasar.doma.jdbc.query.Query

comment, complete, getClassName, getConfig, getMethod, getMethodName, getQueryTimeout, prepare

Method Details

getResult

RESULT getResult()

Returns the result of the function call.

This method is called after executing the function to retrieve the result value. The result type depends on the function's return type and the Java type mapping.

Returns:

the function result