org.eclipse.persistence.queries
Class UpdateObjectQuery

java.lang.Object
  extended by org.eclipse.persistence.queries.DatabaseQuery
      extended by org.eclipse.persistence.queries.ModifyQuery
          extended by org.eclipse.persistence.queries.ObjectLevelModifyQuery
              extended by org.eclipse.persistence.queries.WriteObjectQuery
                  extended by org.eclipse.persistence.queries.UpdateObjectQuery
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class UpdateObjectQuery
extends WriteObjectQuery

Purpose: Used for updating existing objects into the database. This class does not have much behavior. It inherits most of it's behavior from WriteObjectQuery

Since:
TOPLink/Java 1.0
Author:
Yvon Lavoie
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.persistence.queries.DatabaseQuery
CascadeAggregateDelete, CascadeAllParts, CascadeByMapping, CascadeDependentParts, CascadePrivateParts, NoCascading
 
Constructor Summary
UpdateObjectQuery()
          PUBLIC: Default constructor.
UpdateObjectQuery(Call call)
          PUBLIC: Create an update query with the custom call.
UpdateObjectQuery(java.lang.Object objectToUpdate)
          PUBLIC: Create an update query with the object being updated.
 
Method Summary
 void executeCommit()
          INTERNAL: Perform an update.
 void executeCommitWithChangeSet()
          INTERNAL: Perform an update.
 boolean isUpdateObjectQuery()
          PUBLIC: Return if this is an update object query.
 
Methods inherited from class org.eclipse.persistence.queries.WriteObjectQuery
executeDatabaseQuery, isWriteObjectQuery, prepareForExecution
 
Methods inherited from class org.eclipse.persistence.queries.ObjectLevelModifyQuery
checkDescriptor, executeInUnitOfWork, getBackupClone, getObject, getObjectChangeSet, getPrimaryKey, getReferenceClass, getReferenceClassName, isObjectLevelModifyQuery, setBackupClone, setObject, setObjectChangeSet, setPrimaryKey, toString
 
Methods inherited from class org.eclipse.persistence.queries.ModifyQuery
forceBatchStatementExecution, getModifyRow, isModifyQuery, setForceBatchStatementExecution, setModifyRow
 
Methods inherited from class org.eclipse.persistence.queries.DatabaseQuery
addArgument, addArgument, addArgument, addArgumentByTypeName, addArgumentValue, addArgumentValues, addCall, addStatement, bindAllParameters, buildArgumentFields, cacheStatement, cascadeAllParts, cascadeByMapping, cascadeOnlyDependentParts, cascadePrivateParts, checkEarlyReturn, checkPrepare, checkPrepare, clone, convertClassNamesToClasses, copyFromQuery, dontBindAllParameters, dontCacheStatement, dontCascadeParts, dontMaintainCache, execute, extractRemoteResult, getAccessor, getArguments, getArgumentTypeNames, getArgumentTypes, getArgumentValues, getCall, getCascadePolicy, getDatasourceCall, getDatasourceCalls, getDescriptor, getDomainClassNounName, getDoNotRedirect, getEJBQLString, getExecutionSession, getFlushOnExecute, getHintString, getJPQLString, getName, getProperties, getProperty, getQueryMechanism, getQueryNounName, getQueryTimeout, getRedirector, getSelectionCriteria, getSensorName, getSession, getSessionName, getShouldBindAllParameters, getSourceMapping, getSQLStatement, getSQLString, getSQLStrings, getTranslatedSQLString, getTranslatedSQLStrings, getTranslationRow, hasAccessor, hasArguments, hasProperties, hasQueryMechanism, hasSessionName, ignoreBindAllParameters, ignoreCacheStatement, isCallQuery, isCascadeOfAggregateDelete, isCustomQueryUsed, isDataModifyQuery, isDataReadQuery, isDefaultPropertiesQuery, isDeleteAllQuery, isDeleteObjectQuery, isDirectReadQuery, isExecutionClone, isExpressionQuery, isInsertObjectQuery, isJPQLCallQuery, isModifyAllQuery, isNativeConnectionRequired, isObjectBuildingQuery, isObjectLevelReadQuery, isPrepared, isReadAllQuery, isReadObjectQuery, isReadQuery, isReportQuery, isSQLCallQuery, isUpdateAllQuery, isUserDefined, isValueReadQuery, maintainCache, prepareCall, prepareFromQuery, redirectQuery, remoteExecute, removeProperty, replaceValueHoldersIn, retrieveBypassCache, rowFromArguments, setAccessor, setArguments, setArgumentTypeNames, setArgumentTypes, setArgumentValues, setCall, setCascadePolicy, setDatasourceCall, setDescriptor, setDoNotRedirect, setEJBQLString, setFlushOnExecute, setHintString, setIsExecutionClone, setIsNativeConnectionRequired, setIsPrepared, setIsUserDefined, setJPQLString, setName, setProperties, setProperty, setQueryTimeout, setRedirector, setSelectionCriteria, setSession, setSessionName, setShouldBindAllParameters, setShouldBindAllParameters, setShouldCacheStatement, setShouldMaintainCache, setShouldPrepare, setShouldRetrieveBypassCache, setShouldStoreBypassCache, setShouldUseWrapperPolicy, setSourceMapping, setSQLStatement, setSQLString, setTranslationRow, shouldBindAllParameters, shouldCacheStatement, shouldCascadeAllParts, shouldCascadeByMapping, shouldCascadeOnlyDependentParts, shouldCascadeParts, shouldCascadePrivateParts, shouldCloneCall, shouldIgnoreBindAllParameters, shouldIgnoreCacheStatement, shouldMaintainCache, shouldPrepare, shouldRetrieveBypassCache, shouldStoreBypassCache, shouldUseWrapperPolicy, storeBypassCache
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateObjectQuery

public UpdateObjectQuery()
PUBLIC: Default constructor.


UpdateObjectQuery

public UpdateObjectQuery(java.lang.Object objectToUpdate)
PUBLIC: Create an update query with the object being updated.


UpdateObjectQuery

public UpdateObjectQuery(Call call)
PUBLIC: Create an update query with the custom call.

Method Detail

executeCommit

public void executeCommit()
                   throws DatabaseException,
                          OptimisticLockException
INTERNAL: Perform an update.

Overrides:
executeCommit in class WriteObjectQuery
Throws:
DatabaseException
OptimisticLockException

executeCommitWithChangeSet

public void executeCommitWithChangeSet()
                                throws DatabaseException,
                                       OptimisticLockException
INTERNAL: Perform an update.

Overrides:
executeCommitWithChangeSet in class WriteObjectQuery
Throws:
DatabaseException
OptimisticLockException

isUpdateObjectQuery

public boolean isUpdateObjectQuery()
PUBLIC: Return if this is an update object query.

Overrides:
isUpdateObjectQuery in class DatabaseQuery