All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AllFieldsLockingPolicy, ChangedFieldsLockingPolicy, FieldsLockingPolicy, SelectedFieldsLockingPolicy, TimestampLockingPolicy, VersionLockingPolicy
```
public interface OptimisticLockingPolicy
extends Cloneable, Serializable
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OptimisticLockingPolicy.LockOnChange
Advanced:

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addLockFieldsToUpdateRow(AbstractRecord databaseRow, AbstractSession session)`	INTERNAL: Add update fields for template row.
`void`	`addLockValuesToTranslationRow(ObjectLevelModifyQuery query)`	INTERNAL: The method should update the translation row with the correct write lock values.
`Expression`	`buildDeleteExpression(DatabaseTable table, Expression mainExpression, AbstractRecord row)`	INTERNAL: When given an expression, this method will return a new expression with the optimistic locking values included.
`Expression`	`buildUpdateExpression(DatabaseTable table, Expression mainExpression, AbstractRecord translationRow, AbstractRecord modifyRow)`	INTERNAL: When given an expression, this method will return a new expression with the optimistic locking values included.
`Object`	`clone()`
`int`	`compareWriteLockValues(Object value1, Object value2)`	INTERNAL: This method shouldn't be called if supportsWriteLockValuesComparison() returns false.
`Object`	`getBaseValue()`	INTERNAL: This is the base value that is older than all other values, it is used in the place of null in some situations.
`OptimisticLockingPolicy.LockOnChange`	`getLockOnChangeMode()`	ADVANCED: returns the LockOnChange mode for this policy.
`Object`	`getValueToPutInCache(AbstractRecord row, AbstractSession session)`	INTERNAL: Return the value that should be stored in the identity map.
`int`	`getVersionDifference(Object currentValue, Object domainObject, Object primaryKey, AbstractSession session)`	PUBLIC: Return the number of versions different between these objects.
`DatabaseField`	`getWriteLockField()`	INTERNAL: Return the write lock field.
`Expression`	`getWriteLockUpdateExpression(ExpressionBuilder builder, AbstractSession session)`	INTERNAL: This method will return an expression that is used to update its optimistic locking field #see this method in VersionLockingPolicy
`Object`	`getWriteLockValue(Object domainObject, Object primaryKey, AbstractSession session)`	INTERNAL: This method will return the optimistic lock value for the object #see this method in VersionLockingPolicy
`void`	`initialize(AbstractSession session)`	INTERNAL: It is responsible for initializing the policy.
`void`	`initializeProperties()`	INTERNAL: Responsible for pre-initializing.
`boolean`	`isCascaded()`	INTERNAL: Specify if the policy cascade locks.
`boolean`	`isNewerVersion(Object currentValue, Object domainObject, Object primaryKey, AbstractSession session)`	INTERNAL: Returns true if the value stored with the domainObject is more recent than the value .
`boolean`	`isNewerVersion(AbstractRecord databaseRow, Object domainObject, Object primaryKey, AbstractSession session)`	INTERNAL: Returns true if the value stored with the domainObject is more recent than the value in the row.
`boolean`	`isStoredInCache()`	INTERNAL: Return true if the lock value is stored in the cache.
`void`	`mergeIntoParentCache(CacheKey unitOfWorkCacheKey, CacheKey parentSessionCacheKey)`	INTERNAL: This method should merge changes from the parent into the child.
`void`	`mergeIntoParentCache(UnitOfWorkImpl uow, Object primaryKey, Object object)`	INTERNAL: This method should merge changes from the parent into the child.
`void`	`setDescriptor(ClassDescriptor descriptor)`	INTERNAL: provide a way to set the descriptor for this policy
`void`	`setLockOnChangeMode(OptimisticLockingPolicy.LockOnChange lockOnChangeMode)`	ADVANCED: Sets the LockOnChange mode for this policy.
`void`	`setupWriteFieldsForInsert(ObjectLevelModifyQuery query)`	INTERNAL: Add the initial right lock values to the modify row in the query.
`boolean`	`shouldUpdateVersionOnMappingChange()`	INTERNAL: Returns true if the policy has been set to set an optimistic read lock when any mapping changes.
`boolean`	`shouldUpdateVersionOnOwnedMappingChange()`	INTERNAL: Returns true if the policy has been set to set an optimistic read lock when a owning mapping changes.
`boolean`	`supportsWriteLockValuesComparison()`	INTERNAL: Indicates whether compareWriteLockValues method is supported by the policy.
`void`	`updateRowAndObjectForUpdate(ObjectLevelModifyQuery query, Object object)`	INTERNAL: This method should update the translation row, the modify row and the domain object with th lock value.
`void`	`validateDelete(int rowCount, Object object, DeleteObjectQuery query)`
`void`	`validateUpdate(int rowCount, Object object, WriteObjectQuery query)`

- Method Detail
  - addLockFieldsToUpdateRow
```
void addLockFieldsToUpdateRow(AbstractRecord databaseRow,
                              AbstractSession session)
```
    INTERNAL: Add update fields for template row. These are any unmapped fields required to write in an update. #see this method in VersionLockingPolicy
  - addLockValuesToTranslationRow
```
void addLockValuesToTranslationRow(ObjectLevelModifyQuery query)
```
    INTERNAL: The method should update the translation row with the correct write lock values. This method is called on a delete. #see this method in VersionLockingPolicy
  - buildDeleteExpression
```
Expression buildDeleteExpression(DatabaseTable table,
                                 Expression mainExpression,
                                 AbstractRecord row)
```
    INTERNAL: When given an expression, this method will return a new expression with the optimistic locking values included. This expression will be used in a delete call. #see this method in VersionLockingPolicy
  - buildUpdateExpression
```
Expression buildUpdateExpression(DatabaseTable table,
                                 Expression mainExpression,
                                 AbstractRecord translationRow,
                                 AbstractRecord modifyRow)
```
    INTERNAL: When given an expression, this method will return a new expression with the optimistic locking values included. This expression will be used in an update call. #see this method in VersionLockingPolicy
  - clone
```
Object clone()
```
  - supportsWriteLockValuesComparison
```
boolean supportsWriteLockValuesComparison()
```
    INTERNAL: Indicates whether compareWriteLockValues method is supported by the policy. Numeric or timestamp lock values could be compared: for every pair of values v1 and v2 - either v1 lessthan v2; or v1==v2; or v1 greaterthan v2. However it's impossible to compare values for FieldsLockingPolicy for two reasons: 1. there is no "linear order": v1 lessthan v2 and v greaterthan v2 is not defined: either v1==v2 or v1!=v2; 2. locking value is not a single field which is not part of mapped object value but rather a set of object's mapped fields. That means any object's mapped attribute change is potentially a change of the locking value. For ChangedFieldsLockingPolicy every mapped attribute's change is a change of locking value. The pattern used by versioning: "if the original locking value is unchanged then the object hasn't been changed outside of the application", which allows to distinguish between the change made inside and outside the application, doesn't work for fields locking. It degenerates into useless pattern: "if the original locking value is unchanged then the object hasn't been changed". Use compareWriteLockValues method only if this method returns true.
  - compareWriteLockValues
```
int compareWriteLockValues(Object value1,
                           Object value2)
```
    INTERNAL: This method shouldn't be called if supportsWriteLockValuesComparison() returns false. This method compares two writeLockValues. The writeLockValues should be non-null and of the correct type. Returns: -1 if value1 is less (older) than value2; 0 if value1 equals value2; 1 if value1 is greater (newer) than value2. Throws: NullPointerException if the passed value is null; ClassCastException if the passed value is of a wrong type.
  - getBaseValue
```
Object getBaseValue()
```
    INTERNAL: This is the base value that is older than all other values, it is used in the place of null in some situations.
  - getLockOnChangeMode
```
OptimisticLockingPolicy.LockOnChange getLockOnChangeMode()
```
    ADVANCED: returns the LockOnChange mode for this policy. This mode specifies if a Optimistic Write lock should be enforced on this entity when a set of mappings are changed.
  - getValueToPutInCache
```
Object getValueToPutInCache(AbstractRecord row,
                            AbstractSession session)
```
    INTERNAL: Return the value that should be stored in the identity map. If the value is not stored in the cache, then return a null. #see this method in VersionLockingPolicy
  - getVersionDifference
```
int getVersionDifference(Object currentValue,
                         Object domainObject,
                         Object primaryKey,
                         AbstractSession session)
```
    PUBLIC: Return the number of versions different between these objects.
  - getWriteLockField
```
DatabaseField getWriteLockField()
```
    INTERNAL: Return the write lock field. #see this method in VersionLockingPolicy
  - getWriteLockValue
```
Object getWriteLockValue(Object domainObject,
                         Object primaryKey,
                         AbstractSession session)
```
    INTERNAL: This method will return the optimistic lock value for the object #see this method in VersionLockingPolicy
  - getWriteLockUpdateExpression
```
Expression getWriteLockUpdateExpression(ExpressionBuilder builder,
                                        AbstractSession session)
```
    INTERNAL: This method will return an expression that is used to update its optimistic locking field #see this method in VersionLockingPolicy
  - initialize
```
void initialize(AbstractSession session)
```
    INTERNAL: It is responsible for initializing the policy. #see this method in VersionLockingPolicy
  - initializeProperties
```
void initializeProperties()
```
    INTERNAL: Responsible for pre-initializing. #see this method in VersionLockingPolicy
  - isStoredInCache
```
boolean isStoredInCache()
```
    INTERNAL: Return true if the lock value is stored in the cache.
  - isCascaded
```
boolean isCascaded()
```
    INTERNAL: Specify if the policy cascade locks.
  - isNewerVersion
```
boolean isNewerVersion(Object currentValue,
                       Object domainObject,
                       Object primaryKey,
                       AbstractSession session)
```
    INTERNAL: Returns true if the value stored with the domainObject is more recent than the value . Returns false otherwise. #see this method in VersionLockingPolicy
  - isNewerVersion
```
boolean isNewerVersion(AbstractRecord databaseRow,
                       Object domainObject,
                       Object primaryKey,
                       AbstractSession session)
```
    INTERNAL: Returns true if the value stored with the domainObject is more recent than the value in the row. Returns false otherwise. NOTE: This method will only be called if the shouldOnlyRefreshCacheIfNewerVersion() flag is set on descriptor. #see this method in VersionLockingPolicy
  - mergeIntoParentCache
```
void mergeIntoParentCache(UnitOfWorkImpl uow,
                          Object primaryKey,
                          Object object)
```
    INTERNAL: This method should merge changes from the parent into the child. #see this method in VersionLockingPolicy
  - mergeIntoParentCache
```
void mergeIntoParentCache(CacheKey unitOfWorkCacheKey,
                          CacheKey parentSessionCacheKey)
```
    INTERNAL: This method should merge changes from the parent into the child. #see this method in VersionLockingPolicy
  - setDescriptor
```
void setDescriptor(ClassDescriptor descriptor)
```
    INTERNAL: provide a way to set the descriptor for this policy
  - setLockOnChangeMode
```
void setLockOnChangeMode(OptimisticLockingPolicy.LockOnChange lockOnChangeMode)
```
    ADVANCED: Sets the LockOnChange mode for this policy. This mode specifies if a Optimistic Write lock should be enforced on this entity when set of mappings are changed.
  - setupWriteFieldsForInsert
```
void setupWriteFieldsForInsert(ObjectLevelModifyQuery query)
```
    INTERNAL: Add the initial right lock values to the modify row in the query. This method will only be called on insert. #see this method in VersionLockingPolicy
  - updateRowAndObjectForUpdate
```
void updateRowAndObjectForUpdate(ObjectLevelModifyQuery query,
                                 Object object)
```
    INTERNAL: This method should update the translation row, the modify row and the domain object with th lock value. #see this method in VersionLockingPolicy
  - shouldUpdateVersionOnOwnedMappingChange
```
boolean shouldUpdateVersionOnOwnedMappingChange()
```
    INTERNAL: Returns true if the policy has been set to set an optimistic read lock when a owning mapping changes.
  - shouldUpdateVersionOnMappingChange
```
boolean shouldUpdateVersionOnMappingChange()
```
    INTERNAL: Returns true if the policy has been set to set an optimistic read lock when any mapping changes.
  - validateDelete
```
void validateDelete(int rowCount,
                    Object object,
                    DeleteObjectQuery query)
```
  - validateUpdate
```
void validateUpdate(int rowCount,
                    Object object,
                    WriteObjectQuery query)
```

Interface OptimisticLockingPolicy

Nested Class Summary

Method Summary

Method Detail

addLockFieldsToUpdateRow

addLockValuesToTranslationRow

buildDeleteExpression

buildUpdateExpression

clone

supportsWriteLockValuesComparison

compareWriteLockValues

getBaseValue

getLockOnChangeMode

getValueToPutInCache

getVersionDifference

getWriteLockField

getWriteLockValue

getWriteLockUpdateExpression

initialize

initializeProperties

isStoredInCache

isCascaded

isNewerVersion

isNewerVersion

mergeIntoParentCache

mergeIntoParentCache

setDescriptor

setLockOnChangeMode

setupWriteFieldsForInsert

updateRowAndObjectForUpdate

shouldUpdateVersionOnOwnedMappingChange

shouldUpdateVersionOnMappingChange

validateDelete

validateUpdate