oracle.toplink.queryframework
Class DeleteAllQuery

java.lang.Object
oracle.toplink.queryframework.DatabaseQuery
oracle.toplink.queryframework.ModifyQuery
oracle.toplink.queryframework.DeleteAllQuery

All Implemented Interfaces:

java.lang.Cloneable, oracle.toplink.internal.helper.FalseUndefinedTrue, java.io.Serializable

public class DeleteAllQuery

extends ModifyQuery

Purpose: Query used to delete a collection of objects

Responsibilities:

• Stores & retrieves the objects to delete.
• Store the where clause used for the deletion.

Since:

TOPLink/Java 1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.queryframework.DatabaseQuery

CascadeAggregateDelete, CascadeAllParts, CascadeDependentParts, CascadePrivateParts, NoCascading, QUERY_PREPARE

Fields inherited from interface oracle.toplink.internal.helper.FalseUndefinedTrue

False, True, Undefined

Constructor Summary

DeleteAllQuery()

Method Summary

java.lang.Object	execute() INTERNAL: Perform the work to delete a collection of objects.
void	executeDeleteAll(oracle.toplink.publicinterface.Session session, DatabaseRow translationRow, java.util.Vector objects) INTERNAL: Delete all queries are executed specially to avoid cloning and ensure preparing.
java.util.Vector	getObjects() PUBLIC: Return the objects that are to be deleted
java.lang.Class	getReferenceClass() PUBLIC: Return the reference class of the query
void	setObjects(java.util.Vector objectCollection) PUBLIC (REQUIRED): Set the objects to be deleted.
void	setReferenceClass(java.lang.Class aClass) PUBLIC (REQUIRED): Set the reference class for the query

Methods inherited from class oracle.toplink.queryframework.ModifyQuery

getModifyRow, isModifyQuery, setModifyRow

Methods inherited from class oracle.toplink.queryframework.DatabaseQuery

addArgument, addArgument, addArgument, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, cacheStatement, cascadeAllParts, cascadeOnlyDependentParts, cascadePrivateParts, checkEarlyReturn, checkPrepare, clone, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, extractRemoteResult, getAccessor, getArguments, getArgumentTypes, getArgumentValues, getCall, getCascadePolicy, getDescriptor, getEJBQLString, getHintString, getName, getProperties, getProperty, getQueryMechanism, getQueryTimeout, getRedirector, getSelectionCriteria, getSession, getSessionName, getSQLStatement, getSQLString, getTranslatedSQLString, getTranslationRow, hasAccessor, hasProperties, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isDataModifyQuery, isDataReadQuery, isDeleteObjectQuery, isExpressionQuery, isObjectLevelModifyQuery, isObjectLevelReadQuery, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUserDefined, isWriteObjectQuery, maintainCache, prepareCall, prepareForExecution, redirectQuery, remoteExecute, removeProperty, replaceValueHoldersIn, rowFromArguments, setAccessor, setArguments, setArgumentTypes, setArgumentValues, setCall, setCascadePolicy, setDescriptor, setEJBQLString, setHintString, setIsUserDefined, setName, setProperties, setProperty, setQueryTimeout, setRedirector, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldUseWrapperPolicy, setSQLStatement, setSQLString, setTranslationRow, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldIgnoreMaintainCache, shouldMaintainCache, shouldPrepare, shouldUseWrapperPolicy, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteAllQuery

public DeleteAllQuery()

Method Detail

execute

public java.lang.Object execute()
                         throws DatabaseException

INTERNAL: Perform the work to delete a collection of objects. This skips the optimistic lock check and should not called for objects using locking.

Specified by:

execute in class DatabaseQuery

Returns:

vector - the objects being deleted.

Throws:

DatabaseException - - an error has occurred on the database.

executeDeleteAll

public void executeDeleteAll(oracle.toplink.publicinterface.Session session,
DatabaseRow translationRow,
                             java.util.Vector objects)
                      throws DatabaseException

INTERNAL: Delete all queries are executed specially to avoid cloning and ensure preparing.

Throws:

DatabaseException

getObjects

public java.util.Vector getObjects()

PUBLIC: Return the objects that are to be deleted

getReferenceClass

public java.lang.Class getReferenceClass()

PUBLIC: Return the reference class of the query

Overrides:

getReferenceClass in class DatabaseQuery

setObjects

public void setObjects(java.util.Vector objectCollection)

PUBLIC (REQUIRED): Set the objects to be deleted. Also REQUIRED is a selection criteria or SQL string that performs the deletion of the objects. This does not generate the SQL call from the deleted objects. #setObject() should not be called.

setReferenceClass

public void setReferenceClass(java.lang.Class aClass)

PUBLIC (REQUIRED): Set the reference class for the query