EclipseLink Core 4.0.2 · org.eclipse.persistence.sessions.UnitOfWork

Modifier and Type	Class and Description
public static enum	UnitOfWork.CommitOrderType Defines the ordering of updates and deletes of a set of the same entity type during a commit or flush operation.

Method Summary

Modifier and Type	Method and Description
public void	addReadOnlyClass(Class<?> theClass) PUBLIC: Adds the given Java class to the receiver's set of read-only classes.
public void	addReadOnlyClasses(Collection<E> classes) PUBLIC: Adds the classes in the given Vector to the existing set of read-only classes.
public void	assignSequenceNumber(Object object) ADVANCED: Assign sequence number to the object.
public void	assignSequenceNumbers() ADVANCED: Assign sequence numbers to all new objects registered in this unit of work, or any new objects reference by any objects registered.
public void	beginEarlyTransaction() PUBLIC: Tell the unit of work to begin a transaction now.
public void	commit() PUBLIC: Commit the unit of work to its parent.
public void	commitAndResume() PUBLIC: Commit the unit of work to its parent.
public void	commitAndResumeOnFailure() PUBLIC: Commit the unit of work to its parent.
public Object	Returns: the registered version for the clone being merged. deepMergeClone(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy.
public Object	Returns: the object reverted. deepRevertObject(Object clone) PUBLIC: Revert the object's attributes from the parent.
public void	deepUnregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work.
public void	deleteAllObjects(Collection<E> domainObjects) PUBLIC: Delete all of the objects and all of their privately owned parts in the database.
public Object	deleteObject(Object domainObject) PUBLIC: Delete the object and all of their privately owned parts in the database.
public void	dontPerformValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public void	forceUpdateToVersionField(Object cloneFromUOW, boolean shouldModifyVersionField) ADVANCED: Set optimistic read lock on the object.
public UnitOfWork.CommitOrderType	getCommitOrder() ADVANCED: Return the commit order.
public UnitOfWorkChangeSet	getCurrentChanges() ADVANCED: This method will calculate the changes for the UnitOfWork.
public Object	getOriginalVersionOfObject(Object workingClone) ADVANCED: Return the original version of the object(clone) from the parent's identity map.
public AbstractSession	getParent() PUBLIC: Return the parent.
public Set<E>	getReadOnlyClasses() ADVANCED: Returns the set of read-only classes in this UnitOfWork.
public Object	getReference(Class<?> theClass, Object - The primary key of the object, either as a List, singleton, IdClass or an instance of the object. primaryKey) Get an instance, whose state may be lazily fetched.
public UnitOfWorkChangeSet	getUnitOfWorkChangeSet() ADVANCED: Returns the currentChangeSet from the UnitOfWork.
public int	getValidationLevel() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public boolean	hasChanges() ADVANCED: The Unit of work is capable of preprocessing to determine if any on the clone have been changed.
public boolean	isActive() PUBLIC: Return if the unit of work is active (has not been released).
public boolean	Returns: true if the class is read-only, false otherwise. isClassReadOnly(Class<?> theClass) PUBLIC: Checks to see if the specified class is read-only or not in this UnitOfWork.
public boolean	isNestedUnitOfWork() ADVANCED: Return if this session is a nested unit of work.
public boolean	isObjectRegistered(Object clone) ADVANCED: Return whether the clone object is already registered.
public Object	Returns: the registered version for the clone being merged. mergeClone(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy.
public Object	Returns: the registered version for the clone being merged. mergeCloneWithReferences(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy.
public Object	newInstance(Class<?> theClass) PUBLIC: Return a new instance of the class registered in this unit of work.
public void	performFullValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public void	performPartialValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public void	printRegisteredObjects() PUBLIC: Print the objects in the unit of work.
public Object	refreshAndLockObject(Object object) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database.
public Object	refreshAndLockObject(Object object, short lockMode) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database.
public Vector<E>	Returns: is the clones of the original objects, the return value must be used for editing, editing the original is not allowed in the unit of work. registerAllObjects(Collection<E> domainObjects) PUBLIC: Register the objects with the unit of work.
public Object	Returns: The clone of the original object, the return value must be used for editing. Editing the original is not allowed in the unit of work. registerExistingObject(Object existingObject) ADVANCED: Register the existing object with the unit of work.
public Object	registerNewObject(Object newObject) ADVANCED: Register the new object with the unit of work.
public Object	Returns: the clone of the original object, the return value must be used for editing, Editing the original is not allowed in the unit of work. registerObject(Object domainObject) PUBLIC: Register the object with the unit of work.
public void	release() Redeclares org.eclipse.persistence.sessions.Session.release. PUBLIC: Release the unit of work.
public void	removeAllReadOnlyClasses() PUBLIC: Empties the set of read-only classes.
public void	removeForceUpdateToVersionField(Object cloneFromUOW) ADVANCED: Remove optimistic read lock from the object See forceUpdateToVersionField(Object)
public void	removeReadOnlyClass(Class<?> theClass) PUBLIC: Removes a Class from the receiver's set of read-only classes.
public void	revertAndResume() PUBLIC: Revert all changes made to any registered object.
public Object	Returns: the object reverted. revertObject(Object clone) PUBLIC: Revert the object's attributes from the parent.
public void	setCommitOrder(UnitOfWork.CommitOrderType order) ADVANCED: Set the commit order.
public void	setShouldNewObjectsBeCached(boolean shouldNewObjectsBeCached) ADVANCED: By default new objects are not cached until the exist on the database.
public void	setShouldPerformDeletesFirst(boolean shouldPerformDeletesFirst) ADVANCED: By default deletes are performed last in a unit of work.
public void	setShouldThrowConformExceptions(int shouldThrowExceptions) ADVANCED: Conforming queries can be set to provide different levels of detail about the exceptions they encounter There are two levels: DO_NOT_THROW_CONFORM_EXCEPTIONS = 0; THROW_ALL_CONFORM_EXCEPTIONS = 1;
public void	setValidationLevel(int validationLevel) ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public Object	Returns: the registered version for the clone being merged. shallowMergeClone(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy.
public Object	Returns: the object reverted. shallowRevertObject(Object clone) PUBLIC: Revert the object's attributes from the parent.
public void	shallowUnregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work.
public boolean	shouldNewObjectsBeCached() ADVANCED: By default new objects are not cached until the exist on the database.
public boolean	shouldPerformDeletesFirst() ADVANCED: By default all objects are inserted and updated in the database before any object is deleted.
public boolean	shouldPerformFullValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public boolean	shouldPerformNoValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public boolean	shouldPerformPartialValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache.
public void	unregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work.
public void	validateObjectSpace() ADVANCED: This can be used to help debugging an object-space corruption.
public void	writeChanges() ADVANCED: Writes all changes now before commit().

Inherited from org.eclipse.persistence.sessions.Session:: acquireHistoricalSession acquireUnitOfWork acquireUnitOfWork addJPAQuery addQuery clearIntegrityChecker clearProfile containsQuery copy copy doesObjectExist dontLogMessages executeNonSelectingCall executeNonSelectingSQL executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeQuery executeSelectingCall executeSQL getActiveSession getActiveUnitOfWork getAsOfClause getClassDescriptor getClassDescriptor getClassDescriptorForAlias getDatasourceLogin getDatasourcePlatform getDefaultReferenceMode getDescriptor getDescriptor getDescriptorForAlias getDescriptors getEventManager getExceptionHandler getExternalTransactionController getId getIdentityMapAccessor getIntegrityChecker getJPAQueries getLog getLogin getLogLevel getLogLevel getName getNextSequenceNumberValue getPartitioningPolicy getPlatform getProfiler getProject getProperties getProperty getQueries getQuery getQuery getSerializer getServerPlatform getSessionLog handleException handleSevere hasDescriptor hasExceptionHandler hasExternalTransactionController isClientSession isConnected isDatabaseSession isDistributedSession isFinalizersEnabled isInProfile isRemoteSession isRemoteUnitOfWork isServerSession isSessionBroker isUnitOfWork log logMessage readAllObjects readAllObjects readAllObjects readObject readObject readObject readObject refreshObject removeProperty removeQuery setDefaultReferenceMode setExceptionHandler setExternalTransactionController setIntegrityChecker setIsFinalizersEnabled setLog setLogLevel setName setPartitioningPolicy setProfiler setProperty setQueryTimeoutDefault setQueryTimeoutUnitDefault setSerializer setSessionLog shouldLog shouldLogMessages validateCache

Method Detail

addReadOnlyClass	back to summary
public void addReadOnlyClass(Class<?> theClass) PUBLIC: Adds the given Java class to the receiver's set of read-only classes. Cannot be called after objects have been registered in the unit of work.

addReadOnlyClasses	back to summary
public void addReadOnlyClasses(Collection<E> classes) PUBLIC: Adds the classes in the given Vector to the existing set of read-only classes. Cannot be called after objects have been registered in the unit of work.

assignSequenceNumber	back to summary
public void assignSequenceNumber(Object object) throws DatabaseException ADVANCED: Assign sequence number to the object. This allows for an object's id to be assigned before commit. It can be used if the application requires to use the object id before the object exists on the database. Normally all ids are assigned during the commit automatically.

assignSequenceNumbers	back to summary
public void assignSequenceNumbers() throws DatabaseException ADVANCED: Assign sequence numbers to all new objects registered in this unit of work, or any new objects reference by any objects registered. This allows for an object's id to be assigned before commit. It can be used if the application requires to use the object id before the object exists on the database. Normally all ids are assigned during the commit automatically.

assignSequenceNumbers

back to summary

public void assignSequenceNumbers() throws DatabaseException

ADVANCED: Assign sequence numbers to all new objects registered in this unit of work, or any new objects reference by any objects registered. This allows for an object's id to be assigned before commit. It can be used if the application requires to use the object id before the object exists on the database. Normally all ids are assigned during the commit automatically.

beginEarlyTransaction back to summary

beginEarlyTransaction	back to summary
public void beginEarlyTransaction() throws DatabaseException PUBLIC: Tell the unit of work to begin a transaction now. By default the unit of work will begin a transaction at commit time. The default is the recommended approach, however sometimes it is necessary to start the transaction before commit time. When the unit of work commits, this transaction will be committed. See Also `commit()`, `release()`

public void beginEarlyTransaction() throws DatabaseException

PUBLIC: Tell the unit of work to begin a transaction now. By default the unit of work will begin a transaction at commit time. The default is the recommended approach, however sometimes it is necessary to start the transaction before commit time. When the unit of work commits, this transaction will be committed.

See Also: commit(), release()

commit back to summary

commit	back to summary
public void commit() throws DatabaseException, OptimisticLockException PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, and the unit of work will be released. If the commit is successful the unit of work is released, and a new unit of work must be acquired if further changes are desired. See Also `commitAndResumeOnFailure()`, `commitAndResume()`, `release()`

public void commit() throws DatabaseException, OptimisticLockException

PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, and the unit of work will be released. If the commit is successful the unit of work is released, and a new unit of work must be acquired if further changes are desired.

See Also: commitAndResumeOnFailure(), commitAndResume(), release()

commitAndResume back to summary

commitAndResume	back to summary
public void commitAndResume() throws DatabaseException, OptimisticLockException PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, and the unit of work will be released. The normal commit releases the unit of work, forcing a new one to be acquired if further changes are desired. The resuming feature allows for the same unit of work (and working copies) to be continued to be used. See Also `commitAndResumeOnFailure()`, `commit()`, `release()`

public void commitAndResume() throws DatabaseException, OptimisticLockException

PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, and the unit of work will be released. The normal commit releases the unit of work, forcing a new one to be acquired if further changes are desired. The resuming feature allows for the same unit of work (and working copies) to be continued to be used.

See Also: commitAndResumeOnFailure(), commit(), release()

commitAndResumeOnFailure back to summary

commitAndResumeOnFailure	back to summary
public void commitAndResumeOnFailure() throws DatabaseException, OptimisticLockException PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, but the unit of work will remain active. It can then be retried or released. The normal commit failure releases the unit of work, forcing a new one to be acquired if further changes are desired. The resuming feature allows for the same unit of work (and working copies) to be continued to be used if an error occurs. The UnitOfWork will also remain active if the commit is successful. See Also `commit()`, `release()`

public void commitAndResumeOnFailure() throws DatabaseException, OptimisticLockException

PUBLIC: Commit the unit of work to its parent. For a nested unit of work this will merge any changes to its objects with its parents. For a first level unit of work it will commit all changes to its objects to the database as a single transaction. If successful the changes to its objects will be merged to its parent's objects. If the commit fails the database transaction will be rolledback, but the unit of work will remain active. It can then be retried or released. The normal commit failure releases the unit of work, forcing a new one to be acquired if further changes are desired. The resuming feature allows for the same unit of work (and working copies) to be continued to be used if an error occurs. The UnitOfWork will also remain active if the commit is successful.

See Also: commit(), release()

deepMergeClone back to summary

deepMergeClone	back to summary
public Object deepMergeClone(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization or other serialization mechanisms, because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. Everything connected to this object (i.e. the entire object tree where rmiClone is the root) is also merged. Returns:Object the registered version for the clone being merged. See Also `mergeClone(Object)`, `shallowMergeClone(Object)`

public Object deepMergeClone(Object rmiClone)

PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization or other serialization mechanisms, because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. Everything connected to this object (i.e. the entire object tree where rmiClone is the root) is also merged.

Returns:Object: the registered version for the clone being merged.
See Also: mergeClone(Object), shallowMergeClone(Object)

deepRevertObject back to summary

deepRevertObject	back to summary
public Object deepRevertObject(Object clone) PUBLIC: Revert the object's attributes from the parent. This reverts everything the object references. Returns:Object the object reverted. See Also `revertObject(Object)`, `shallowRevertObject(Object)`

public Object deepRevertObject(Object clone)

PUBLIC: Revert the object's attributes from the parent. This reverts everything the object references.

Returns:Object: the object reverted.
See Also: revertObject(Object), shallowRevertObject(Object)

deepUnregisterObject	back to summary
public void deepUnregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work. This can be used to delete an object that was just created and is not yet persistent. Delete object can also be used, but will result in inserting the object and then deleting it. The method should be used carefully because it will delete all the reachable parts.

deleteAllObjects	back to summary
public void deleteAllObjects(Collection<E> domainObjects) PUBLIC: Delete all of the objects and all of their privately owned parts in the database. Delete operations are delayed in a unit of work until commit.

deleteObject	back to summary
public Object deleteObject(Object domainObject) PUBLIC: Delete the object and all of their privately owned parts in the database. Delete operations are delayed in a unit of work until commit.

dontPerformValidation	back to summary
public void dontPerformValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache. The level of validation can be increased or decreased for debugging purposes or under advanced situation where the application requires/desires to violate clone identity in the unit of work. It is strongly suggested that clone identity not be violate in the unit of work.

dontPerformValidation

back to summary

public void dontPerformValidation()

ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache. The level of validation can be increased or decreased for debugging purposes or under advanced situation where the application requires/desires to violate clone identity in the unit of work. It is strongly suggested that clone identity not be violate in the unit of work.

forceUpdateToVersionField	back to summary
public void forceUpdateToVersionField(Object cloneFromUOW, boolean shouldModifyVersionField) ADVANCED: Set optimistic read lock on the object. This feature is override by normal optimistic lock. when the object is changed in UnitOfWork. The cloneFromUOW must be the clone of from this UnitOfWork and it must implements version locking or timestamp locking. The SQL would look like the followings. If shouldModifyVersionField is true, "UPDATE EMPLOYEE SET VERSION = 2 WHERE EMP_ID = 9 AND VERSION = 1" If shouldModifyVersionField is false, "UPDATE EMPLOYEE SET VERSION = 1 WHERE EMP_ID = 9 AND VERSION = 1"

forceUpdateToVersionField

back to summary

public void forceUpdateToVersionField(Object cloneFromUOW, boolean shouldModifyVersionField)

ADVANCED: Set optimistic read lock on the object. This feature is override by normal optimistic lock. when the object is changed in UnitOfWork. The cloneFromUOW must be the clone of from this UnitOfWork and it must implements version locking or timestamp locking. The SQL would look like the followings. If shouldModifyVersionField is true, "UPDATE EMPLOYEE SET VERSION = 2 WHERE EMP_ID = 9 AND VERSION = 1" If shouldModifyVersionField is false, "UPDATE EMPLOYEE SET VERSION = 1 WHERE EMP_ID = 9 AND VERSION = 1"

getCommitOrder	back to summary
public UnitOfWork.CommitOrderType getCommitOrder() ADVANCED: Return the commit order.

getCurrentChanges	back to summary
public UnitOfWorkChangeSet getCurrentChanges() ADVANCED: This method will calculate the changes for the UnitOfWork. Without assigning sequence numbers. This is a computationaly intensive operation and should be avoided unless necessary. A valid changeSet, with sequence numbers can be collected from the UnitOfWork after the commit is complete by calling unitOfWork.getUnitOfWorkChangeSet().

getOriginalVersionOfObject	back to summary
public Object getOriginalVersionOfObject(Object workingClone) ADVANCED: Return the original version of the object(clone) from the parent's identity map.

getParent	back to summary
public AbstractSession getParent() PUBLIC: Return the parent. This is a unit of work if nested, otherwise a database session or client session.

getReadOnlyClasses	back to summary
public Set<E> getReadOnlyClasses() ADVANCED: Returns the set of read-only classes in this UnitOfWork.

getReference	back to summary
public Object getReference(Class<?> theClass, Object primaryKey) Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, null is returned, or the object will fail when accessed. The instance will be lazy when it does not exist in the cache, and supports fetch groups. Parameters primaryKey:Object - The primary key of the object, either as a List, singleton, IdClass or an instance of the object.

getReference

back to summary

public Object getReference(Class<?> theClass, Object primaryKey)

Get an instance, whose state may be lazily fetched. If the requested instance does not exist in the database, null is returned, or the object will fail when accessed. The instance will be lazy when it does not exist in the cache, and supports fetch groups.

Parameters

primaryKey:Object: - The primary key of the object, either as a List, singleton, IdClass or an instance of the object.

getUnitOfWorkChangeSet	back to summary
public UnitOfWorkChangeSet getUnitOfWorkChangeSet() ADVANCED: Returns the currentChangeSet from the UnitOfWork. This is only valid after the UnitOfWork has committed successfully

getValidationLevel	back to summary
public int getValidationLevel() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache. The level of validation can be increased or decreased for debugging purposes or under advanced situation where the application requires/desires to violate clone identity in the unit of work. It is strongly suggested that clone identity not be violate in the unit of work.

getValidationLevel

back to summary

public int getValidationLevel()

hasChanges	back to summary
public boolean hasChanges() ADVANCED: The Unit of work is capable of preprocessing to determine if any on the clone have been changed. This is computationally expensive and should be avoided on large object graphs.

isActive	back to summary
public boolean isActive() PUBLIC: Return if the unit of work is active (has not been released).

isClassReadOnly	back to summary
public boolean isClassReadOnly(Class<?> theClass) PUBLIC: Checks to see if the specified class is read-only or not in this UnitOfWork. Returns:boolean true if the class is read-only, false otherwise.

isClassReadOnly

back to summary

public boolean isClassReadOnly(Class<?> theClass)

PUBLIC: Checks to see if the specified class is read-only or not in this UnitOfWork.

Returns:boolean: true if the class is read-only, false otherwise.

isNestedUnitOfWork	back to summary
public boolean isNestedUnitOfWork() ADVANCED: Return if this session is a nested unit of work.

isObjectRegistered	back to summary
public boolean isObjectRegistered(Object clone) ADVANCED: Return whether the clone object is already registered.

mergeClone back to summary

mergeClone	back to summary
public Object mergeClone(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization (or another serialization mechanism), because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. The object and its private owned parts are merged. Returns:Object the registered version for the clone being merged. See Also `shallowMergeClone(Object)`, `deepMergeClone(Object)`

public Object mergeClone(Object rmiClone)

PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization (or another serialization mechanism), because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. The object and its private owned parts are merged.

Returns:Object: the registered version for the clone being merged.
See Also: shallowMergeClone(Object), deepMergeClone(Object)

mergeCloneWithReferences back to summary

mergeCloneWithReferences	back to summary
public Object mergeCloneWithReferences(Object rmiClone) PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization (or another serialization mechanism), because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. The object and its private owned parts are merged. This will include references from this clone to independent objects. Returns:Object the registered version for the clone being merged. See Also `shallowMergeClone(Object)`, `deepMergeClone(Object)`

public Object mergeCloneWithReferences(Object rmiClone)

Returns:Object: the registered version for the clone being merged.
See Also: shallowMergeClone(Object), deepMergeClone(Object)

newInstance	back to summary
public Object newInstance(Class<?> theClass) PUBLIC: Return a new instance of the class registered in this unit of work. This can be used to ensure that new objects are registered correctly.

performFullValidation	back to summary
public void performFullValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache. The level of validation can be increased or decreased for debugging purposes or under advanced situation where the application requires/desires to violate clone identity in the unit of work. It is strongly suggested that clone identity not be violate in the unit of work.

performFullValidation

back to summary

public void performFullValidation()

performPartialValidation	back to summary
public void performPartialValidation() ADVANCED: The unit of work performs validations such as, ensuring multiple copies of the same object don't exist in the same unit of work, ensuring deleted objects are not referred after commit, ensures that objects from the parent cache are not referred in the unit of work cache. The level of validation can be increased or decreased for debugging purposes or under advanced situation where the application requires/desires to violate clone identity in the unit of work. It is strongly suggested that clone identity not be violate in the unit of work.

performPartialValidation

back to summary

public void performPartialValidation()

printRegisteredObjects	back to summary
public void printRegisteredObjects() PUBLIC: Print the objects in the unit of work.

refreshAndLockObject back to summary

refreshAndLockObject	back to summary
public Object refreshAndLockObject(Object object) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction. If the object is already locked this method will wait until the lock is released. A no wait option is available through setting the lock mode. See Also `refreshAndLockObject(Object, short)`

public Object refreshAndLockObject(Object object)

PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction. If the object is already locked this method will wait until the lock is released. A no wait option is available through setting the lock mode.

See Also: refreshAndLockObject(Object, short)

refreshAndLockObject	back to summary
public Object refreshAndLockObject(Object object, short lockMode) PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction. Lock Modes: ObjectBuildingQuery.NO_LOCK, LOCK, LOCK_NOWAIT

refreshAndLockObject

back to summary

public Object refreshAndLockObject(Object object, short lockMode)

PUBLIC: Refresh the attributes of the object and of all of its private parts from the database. The object will be pessimistically locked on the database for the duration of the transaction.

Lock Modes: ObjectBuildingQuery.NO_LOCK, LOCK, LOCK_NOWAIT

registerAllObjects	back to summary
public Vector<E> registerAllObjects(Collection<E> domainObjects) PUBLIC: Register the objects with the unit of work. All newly created root domain objects must be registered to be inserted on commit. Also any existing objects that will be edited and were not read from this unit of work must also be registered. Once registered any changes to the objects will be committed to the database on commit. Returns:Vector<E> is the clones of the original objects, the return value must be used for editing, editing the original is not allowed in the unit of work.

registerAllObjects

back to summary

public Vector<E> registerAllObjects(Collection<E> domainObjects)

PUBLIC: Register the objects with the unit of work. All newly created root domain objects must be registered to be inserted on commit. Also any existing objects that will be edited and were not read from this unit of work must also be registered. Once registered any changes to the objects will be committed to the database on commit.

Returns:Vector<E>: is the clones of the original objects, the return value must be used for editing, editing the original is not allowed in the unit of work.

registerExistingObject	back to summary
public Object registerExistingObject(Object existingObject) ADVANCED: Register the existing object with the unit of work. This is a advanced API that can be used if the application can guaranteed the object exists on the database. When registerObject is called the unit of work determines existence through the descriptor's doesExist setting. Returns:Object The clone of the original object, the return value must be used for editing. Editing the original is not allowed in the unit of work.

registerExistingObject

back to summary

public Object registerExistingObject(Object existingObject)

ADVANCED: Register the existing object with the unit of work. This is a advanced API that can be used if the application can guaranteed the object exists on the database. When registerObject is called the unit of work determines existence through the descriptor's doesExist setting.

Returns:Object: The clone of the original object, the return value must be used for editing. Editing the original is not allowed in the unit of work.

registerNewObject back to summary

registerNewObject	back to summary
public Object registerNewObject(Object newObject) ADVANCED: Register the new object with the unit of work. This will register the new object without cloning. Normally the registerObject method should be used for all registration of new and existing objects. This version of the register method can only be used for new objects. This method should only be used if a new object is desired to be registered without cloning. See Also `registerObject(Object)`

public Object registerNewObject(Object newObject)

ADVANCED: Register the new object with the unit of work. This will register the new object without cloning. Normally the registerObject method should be used for all registration of new and existing objects. This version of the register method can only be used for new objects. This method should only be used if a new object is desired to be registered without cloning.

See Also: registerObject(Object)

registerObject	back to summary
public Object registerObject(Object domainObject) PUBLIC: Register the object with the unit of work. All newly created root domain objects must be registered to be inserted on commit. Also any existing objects that will be edited and were not read from this unit of work must also be registered. Once registered any changes to the objects will be committed to the database on commit. Returns:Object the clone of the original object, the return value must be used for editing, Editing the original is not allowed in the unit of work.

registerObject

back to summary

public Object registerObject(Object domainObject)

PUBLIC: Register the object with the unit of work. All newly created root domain objects must be registered to be inserted on commit. Also any existing objects that will be edited and were not read from this unit of work must also be registered. Once registered any changes to the objects will be committed to the database on commit.

Returns:Object: the clone of the original object, the return value must be used for editing, ** Editing the original is not allowed in the unit of work. **

release back to summary

release	back to summary
public void release() Redeclares org.eclipse.persistence.sessions.Session.release. PUBLIC: Release the unit of work. This terminates this unit of work. Because the unit of work operates on its own object space (clones) no work is required. The unit of work should no longer be used or referenced by the application beyond this point so that it can garbage collect. Annotations @Override See Also `commit()`

public void release()

Redeclares org.eclipse.persistence.sessions.Session.release.

PUBLIC: Release the unit of work. This terminates this unit of work. Because the unit of work operates on its own object space (clones) no work is required. The unit of work should no longer be used or referenced by the application beyond this point so that it can garbage collect.

Annotations

@Override

See Also

commit()

removeAllReadOnlyClasses	back to summary
public void removeAllReadOnlyClasses() PUBLIC: Empties the set of read-only classes. It is illegal to call this method on nested UnitOfWork objects. A nested UnitOfWork cannot have a subset of its parent's set of read-only classes.

removeForceUpdateToVersionField	back to summary
public void removeForceUpdateToVersionField(Object cloneFromUOW) ADVANCED: Remove optimistic read lock from the object See forceUpdateToVersionField(Object)

removeReadOnlyClass	back to summary
public void removeReadOnlyClass(Class<?> theClass) PUBLIC: Removes a Class from the receiver's set of read-only classes. It is illegal to try to send this method to a nested UnitOfWork.

revertAndResume back to summary

revertAndResume	back to summary
public void revertAndResume() PUBLIC: Revert all changes made to any registered object. Clear all deleted and new objects. Revert should not be confused with release which it the normal compliment to commit. Revert is more similar to commit and resume, however reverts all changes and resumes. If you do not require to resume the unit of work release should be used instead. See Also `commitAndResume()`, `release()`

public void revertAndResume()

PUBLIC: Revert all changes made to any registered object. Clear all deleted and new objects. Revert should not be confused with release which it the normal compliment to commit. Revert is more similar to commit and resume, however reverts all changes and resumes. If you do not require to resume the unit of work release should be used instead.

See Also: commitAndResume(), release()

revertObject back to summary

revertObject	back to summary
public Object revertObject(Object clone) PUBLIC: Revert the object's attributes from the parent. This also reverts the object privately-owned parts. Returns:Object the object reverted. See Also `shallowRevertObject(Object)`, `deepRevertObject(Object)`

public Object revertObject(Object clone)

PUBLIC: Revert the object's attributes from the parent. This also reverts the object privately-owned parts.

Returns:Object: the object reverted.
See Also: shallowRevertObject(Object), deepRevertObject(Object)

setCommitOrder	back to summary
public void setCommitOrder(UnitOfWork.CommitOrderType order) ADVANCED: Set the commit order.

setShouldNewObjectsBeCached	back to summary
public void setShouldNewObjectsBeCached(boolean shouldNewObjectsBeCached) ADVANCED: By default new objects are not cached until the exist on the database. Occasionally if mergeClone is used on new objects and is required to allow multiple merges on the same new object, then if the new objects are not cached, each mergeClone will be interpreted as a different new object. By setting new objects to be cached mergeClone can be performed multiple times before commit. New objects cannot be cached unless they have a valid assigned primary key before being registered. New object with non-null invalid primary keys such as 0 or '' can cause problems and should not be used with this option.

setShouldNewObjectsBeCached

back to summary

public void setShouldNewObjectsBeCached(boolean shouldNewObjectsBeCached)

ADVANCED: By default new objects are not cached until the exist on the database. Occasionally if mergeClone is used on new objects and is required to allow multiple merges on the same new object, then if the new objects are not cached, each mergeClone will be interpreted as a different new object. By setting new objects to be cached mergeClone can be performed multiple times before commit. New objects cannot be cached unless they have a valid assigned primary key before being registered. New object with non-null invalid primary keys such as 0 or '' can cause problems and should not be used with this option.

setShouldPerformDeletesFirst	back to summary
public void setShouldPerformDeletesFirst(boolean shouldPerformDeletesFirst) ADVANCED: By default deletes are performed last in a unit of work. Sometimes you may want to have the deletes performed before other actions.

setShouldThrowConformExceptions	back to summary
public void setShouldThrowConformExceptions(int shouldThrowExceptions) ADVANCED: Conforming queries can be set to provide different levels of detail about the exceptions they encounter There are two levels: DO_NOT_THROW_CONFORM_EXCEPTIONS = 0; THROW_ALL_CONFORM_EXCEPTIONS = 1;

setValidationLevel

back to summary

public void setValidationLevel(int validationLevel)

shallowMergeClone back to summary

public Object shallowMergeClone(Object rmiClone)

PUBLIC: Merge the attributes of the clone into the unit of work copy. This can be used for objects that are returned from the client through RMI serialization (or other serialization mechanisms), because the RMI object will be a clone this will merge its attributes correctly to preserve object identity within the unit of work and record its changes. Only direct attributes are merged.

Returns:Object: the registered version for the clone being merged.
See Also: mergeClone(Object), deepMergeClone(Object)

shallowRevertObject back to summary

public Object shallowRevertObject(Object clone)

PUBLIC: Revert the object's attributes from the parent. This only reverts the object's direct attributes.

Returns:Object: the object reverted.
See Also: revertObject(Object), deepRevertObject(Object)

shallowUnregisterObject	back to summary
public void shallowUnregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work. This can be used to delete an object that was just created and is not yet persistent. Delete object can also be used, but will result in inserting the object and then deleting it. The method will only unregister the clone, none of its parts.

shouldNewObjectsBeCached

back to summary

public boolean shouldNewObjectsBeCached()

shouldPerformDeletesFirst	back to summary
public boolean shouldPerformDeletesFirst() ADVANCED: By default all objects are inserted and updated in the database before any object is deleted. If this flag is set to true, deletes will be performed before inserts and updates

shouldPerformFullValidation

back to summary

public boolean shouldPerformFullValidation()

shouldPerformNoValidation

back to summary

public boolean shouldPerformNoValidation()

shouldPerformPartialValidation

back to summary

public boolean shouldPerformPartialValidation()

unregisterObject	back to summary
public void unregisterObject(Object clone) ADVANCED: Unregister the object with the unit of work. This can be used to delete an object that was just created and is not yet persistent. Delete object can also be used, but will result in inserting the object and then deleting it. The method will only unregister private owned parts

validateObjectSpace

back to summary

public void validateObjectSpace()

ADVANCED: This can be used to help debugging an object-space corruption. An object-space corruption is when your application has incorrectly related a clone to an original object. This method will validate that all registered objects are in a correct state and throw an error if not, it will contain the full stack of object references in the error message. If you call this method after each register or change you perform it will pin-point where the error was made.

writeChanges

back to summary

public void writeChanges()

ADVANCED: Writes all changes now before commit(). The commit process will begin and all changes will be written out to the datastore, but the datastore transaction will not be committed, nor will changes be merged into the global cache.

A subsequent commit (on UnitOfWork or global transaction) will be required to finalize the commit process.

As the commit process has begun any attempt to register objects, or execute object-level queries will generate an exception. Report queries, non-caching queries, and data read/modify queries are allowed.

On exception any global transaction will be rolled marked or marked rollback only. No recovery of this UnitOfWork will be possible.

Can only be called once. It can not be used to write out changes in an incremental fashion.

Use to partially commit a transaction outside of a JTA transaction's callbacks. Allows you to get back any exception directly.

Use to commit a UnitOfWork in two stages.

Modifier and Type	Field and Description
public static final UnitOfWork.CommitOrderType	CHANGES Updates are ordered by the object's changes, then by id. This can improve batch writing efficiency.
public static final UnitOfWork.CommitOrderType	ID Updates and deletes are ordered by the object's id. This can help avoid deadlocks on highly concurrent systems.
public static final UnitOfWork.CommitOrderType	NONE No ordering is done.

Modifier and Type	Method and Description
public static UnitOfWork.CommitOrderType	valueOf(String name)
public static UnitOfWork.CommitOrderType[]	values()

public Interface UnitOfWork

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum UnitOfWork.CommitOrderType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail