org.seasar.doma.jdbc.criteria.context

Class DeleteSettings

java.lang.Object

org.seasar.doma.jdbc.criteria.context.Settings

org.seasar.doma.jdbc.criteria.context.DeleteSettings

public class DeleteSettings
extends Settings

Represents the settings for a DELETE criteria query.

Constructor Summary

Constructors

Constructor and Description
DeleteSettings()

Method Summary

Modifier and Type	Method and Description
boolean	getAllowEmptyWhere() Returns whether the empty WHERE clause is allowed or not.
int	getBatchSize() Returns the batch size.
boolean	getIgnoreVersion() Returns whether to ignore the version property or not.
boolean	getSuppressOptimisticLockException() Returns whether to suppress OptimisticLockException or not.
void	setAllowEmptyWhere(boolean allowEmptyWhere) Sets whether the empty WHERE clause is allowed or not.
void	setBatchSize(int batchSize) Sets the batch size.
void	setIgnoreVersion(boolean ignoreVersion) Sets whether to ignore the version property or not.
void	setSuppressOptimisticLockException(boolean suppressOptimisticLockException) Sets whether to suppress OptimisticLockException or not.

Methods inherited from class org.seasar.doma.jdbc.criteria.context.Settings

getComment, getQueryTimeout, getSqlLogType, setComment, setQueryTimeout, setSqlLogType

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteSettings

public DeleteSettings()

Method Detail

getBatchSize

public int getBatchSize()

Returns the batch size.

Returns:

the batch size. The default value is 0.

setBatchSize

public void setBatchSize(int batchSize)

Sets the batch size.

If the value is less than 1, it is regarded as 1.

Parameters:

batchSize - the batch size

See Also:

Statement.executeBatch(), PreparedStatement.addBatch()

getAllowEmptyWhere

public boolean getAllowEmptyWhere()

Returns whether the empty WHERE clause is allowed or not.

Returns:

whether the empty WHERE clause is allowed or not. The default value is false.

setAllowEmptyWhere

public void setAllowEmptyWhere(boolean allowEmptyWhere)

Sets whether the empty WHERE clause is allowed or not.

If the value is true and the WHERE clause is empty, EmptyWhereClauseException will be suppressed.

Parameters:

allowEmptyWhere - whether the empty WHERE clause is allowed or not

getIgnoreVersion

public boolean getIgnoreVersion()

Returns whether to ignore the version property or not.

Returns:

whether to ignore the version property or not. The default value is false.

setIgnoreVersion

public void setIgnoreVersion(boolean ignoreVersion)

Sets whether to ignore the version property or not.

If the value is true, the column that mapped to the version property is excluded from the SQL DELETE statement.

Parameters:

ignoreVersion - whether to ignore the version property or not

getSuppressOptimisticLockException

public boolean getSuppressOptimisticLockException()

Returns whether to suppress OptimisticLockException or not.

Returns:

whether to suppress OptimisticLockException or not. The default value is false.

setSuppressOptimisticLockException

public void setSuppressOptimisticLockException(boolean suppressOptimisticLockException)

Sets whether to suppress OptimisticLockException or not.

Parameters:

suppressOptimisticLockException - whether to suppress OptimisticLockException or not