AllFieldsLockingPolicy

java.lang.Object
- org.eclipse.persistence.descriptors.FieldsLockingPolicy
- - org.eclipse.persistence.descriptors.AllFieldsLockingPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, OptimisticLockingPolicy
```
public class AllFieldsLockingPolicy
extends FieldsLockingPolicy
```
Purpose: An implementation of the OptimisticLockingPolicy interface. This policy compares every field in the table in the WHERE clause when doing an update or a delete. If any field has been changed, an optimistic locking exception will be thrown.
NOTE: This policy can only be used inside a unit of work.

Since:

TopLink 2.1

Author:

Peter Krogh

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy
  OptimisticLockingPolicy.LockOnChange

Field Summary
- Fields inherited from class org.eclipse.persistence.descriptors.FieldsLockingPolicy
  allNonPrimaryKeyFields, descriptor

Constructor Summary

Constructors
Constructor Description

AllFieldsLockingPolicy()
PUBLIC: Create a new all fields locking policy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addLockValuesToTranslationRow(ObjectLevelModifyQuery query)`	INTERNAL: Values to be included in the locking mechanism are added to the translation row.
`protected java.util.List<DatabaseField>`	`getFieldsToCompare(DatabaseTable table, AbstractRecord transRow, AbstractRecord modifyRow)`	INTERNAL: Returns the fields that should be compared in the where clause.

Methods inherited from class org.eclipse.persistence.descriptors.FieldsLockingPolicy
addLockFieldsToUpdateRow, buildAllNonPrimaryKeyFields, buildDeleteExpression, buildExpression, buildUpdateExpression, clone, compareWriteLockValues, getAllNonPrimaryKeyFields, getAllNonPrimaryKeyFields, getBaseValue, getLockOnChangeMode, getValueToPutInCache, getVersionDifference, getWriteLockField, getWriteLockUpdateExpression, getWriteLockValue, initialize, initializeProperties, isCascaded, isNewerVersion, isNewerVersion, isPrimaryKey, isStoredInCache, mergeIntoParentCache, mergeIntoParentCache, setAllNonPrimaryKeyFields, setDescriptor, setLockOnChangeMode, setupWriteFieldsForInsert, shouldUpdateVersionOnMappingChange, shouldUpdateVersionOnOwnedMappingChange, supportsWriteLockValuesComparison, updateRowAndObjectForUpdate, validateDelete, validateUpdate, verifyUsage

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AllFieldsLockingPolicy
```
public AllFieldsLockingPolicy()
```
    PUBLIC: Create a new all fields locking policy. A field locking policy is based on locking on all fields by comparing with their previous values to detect field-level collisions. Note: the unit of work must be used for all updates when using field locking.
- Method Detail
  - addLockValuesToTranslationRow
```
public void addLockValuesToTranslationRow(ObjectLevelModifyQuery query)
```
    INTERNAL: Values to be included in the locking mechanism are added to the translation row. Set the translation row to all the original field values.
    
    Specified by:
    
    addLockValuesToTranslationRow in interface OptimisticLockingPolicy
    
    Specified by:
    
    addLockValuesToTranslationRow in class FieldsLockingPolicy
  - getFieldsToCompare
```
protected java.util.List<DatabaseField> getFieldsToCompare(DatabaseTable table,
                                                           AbstractRecord transRow,
                                                           AbstractRecord modifyRow)
```
    INTERNAL: Returns the fields that should be compared in the where clause. In this case, it is all the fields, except for the primary key and class indicator.
    
    Specified by:
    
    getFieldsToCompare in class FieldsLockingPolicy