Module org.seasar.doma.core

Package org.seasar.doma.jdbc.query

Interface ModifyQuery

All Superinterfaces:

Query

All Known Subinterfaces:

DeleteQuery, InsertQuery, UpdateQuery

All Known Implementing Classes:

AutoDeleteQuery, AutoInsertQuery, AutoModifyQuery, AutoMultiInsertQuery, AutoUpdateQuery, CriteriaQuery, SqlDeleteQuery, SqlFileDeleteQuery, SqlFileInsertQuery, SqlFileModifyQuery, SqlFileUpdateQuery, SqlInsertQuery, SqlModifyQuery, SqlUpdateQuery

public interface ModifyQuery
extends Query

A query that modifies data in a database.

This interface defines operations specific to data modification statements such as INSERT, UPDATE, and DELETE.

Method Summary

Modifier and Type	Method	Description
PreparedSql	getSql()	Returns the prepared SQL for this modification query.
SqlExecutionSkipCause	getSqlExecutionSkipCause()	Returns the cause if SQL execution should be skipped.
SqlLogType	getSqlLogType()	Returns the SQL log type for this query.
boolean	isAutoGeneratedKeysSupported()	Returns whether auto-generated keys are supported for this query.
boolean	isExecutable()	Returns whether this query is executable.
boolean	isOptimisticLockCheckRequired()	Returns whether optimistic lock checking is required for this query.

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

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

Method Details

getSql

PreparedSql getSql()

Returns the prepared SQL for this modification query.

Specified by:

getSql in interface Query

Returns:

the prepared SQL

isOptimisticLockCheckRequired

boolean isOptimisticLockCheckRequired()

Returns whether optimistic lock checking is required for this query.

Returns:

true if optimistic lock checking is required

isAutoGeneratedKeysSupported

boolean isAutoGeneratedKeysSupported()

Returns whether auto-generated keys are supported for this query.

Returns:

true if auto-generated keys are supported

isExecutable

boolean isExecutable()

Returns whether this query is executable.

Returns:

true if this query is executable

getSqlExecutionSkipCause

SqlExecutionSkipCause getSqlExecutionSkipCause()

Returns the cause if SQL execution should be skipped.

Returns:

the cause of SQL execution skip, or null if execution should not be skipped

getSqlLogType

SqlLogType getSqlLogType()

Returns the SQL log type for this query.

Returns:

the SQL log type