Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / refs/heads/master / . / api / 3.0 / org / eclipse / persistence / descriptors / TimestampLockingPolicy.html
blob: 6fbd7ffb9dbd495727534e1d17c4e2c6927365e8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:47 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TimestampLockingPolicy (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TimestampLockingPolicy (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/descriptors/TimestampLockingPolicy.html" target="_top">Frames</a></li>
<li><a href="TimestampLockingPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.descriptors</div>
<h2 title="Class TimestampLockingPolicy" class="title">Class TimestampLockingPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">org.eclipse.persistence.descriptors.VersionLockingPolicy</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.descriptors.TimestampLockingPolicy</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TimestampLockingPolicy</span>
extends <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></pre>
<div class="block"><p><b>Purpose</b>: Used to allow a single version timestamp to be used for optimistic locking.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.eclipse.persistence.descriptors.TimestampLockingPolicy">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>TOPLink/Java 2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</h3>
<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#LOCAL_TIME">LOCAL_TIME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#retrieveTimeFrom">retrieveTimeFrom</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#SERVER_TIME">SERVER_TIME</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.descriptors.VersionLockingPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.descriptors.<a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></h3>
<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#cachedExpression">cachedExpression</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#descriptor">descriptor</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#IN_CACHE">IN_CACHE</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#IN_OBJECT">IN_OBJECT</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isCascaded">isCascaded</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockMapping">lockMapping</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockOnChangeMode">lockOnChangeMode</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockValueStored">lockValueStored</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#writeLockField">writeLockField</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#TimestampLockingPolicy--">TimestampLockingPolicy</a></span>()</code>
<div class="block">PUBLIC:
Create a new TimestampLockingPolicy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#TimestampLockingPolicy-org.eclipse.persistence.internal.helper.DatabaseField-">TimestampLockingPolicy</a></span>(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;field)</code>
<div class="block">INTERNAL:
Create a new TimestampLockingPolicy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#TimestampLockingPolicy-java.lang.String-">TimestampLockingPolicy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fieldName)</code>
<div class="block">PUBLIC:
Create a new TimestampLockingPolicy.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#compareWriteLockValues-java.lang.Object-java.lang.Object-">compareWriteLockValues</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value2)</code>
<div class="block">INTERNAL:
This method compares two writeLockValues.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getBaseValue--">getBaseValue</a></span>()</code>
<div class="block">INTERNAL:
This is the base value that is older than all other values, it is used in the place of
null in some situations.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getDefaultLockingFieldType--">getDefaultLockingFieldType</a></span>()</code>
<div class="block">INTERNAL:
Return the default timestamp locking filed java type, default is Timestamp.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getInitialWriteValue-org.eclipse.persistence.internal.sessions.AbstractSession-">getInitialWriteValue</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
returns the initial locking value</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getNewLockValue-org.eclipse.persistence.queries.ModifyQuery-">getNewLockValue</a></span>(<a href="../../../../org/eclipse/persistence/queries/ModifyQuery.html" title="class in org.eclipse.persistence.queries">ModifyQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
Returns the new Timestamp value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getValueToPutInCache-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">getValueToPutInCache</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Return the value that should be stored in the identity map.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getVersionDifference-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getVersionDifference</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;currentValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKeys,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Return the number of versions different between these objects.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getWriteLockUpdateExpression-org.eclipse.persistence.expressions.ExpressionBuilder-org.eclipse.persistence.internal.sessions.AbstractSession-">getWriteLockUpdateExpression</a></span>(<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Return an expression that updates the write lock</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#getWriteLockValue-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getWriteLockValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
This method will return the optimistic lock value for the object.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#incrementWriteLockValue-java.lang.Number-">incrementWriteLockValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;numberValue)</code>
<div class="block">INTERNAL:
Timestamp versioning should not be able to do this.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#isNewerVersion-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">isNewerVersion</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Compares the value from the row and from the object (or cache).</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#isNewerVersion-java.lang.Object-java.lang.Object-">isNewerVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;firstLockFieldValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;secondWriteLockFieldValue)</code>
<div class="block">INTERNAL:
Compares two values.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#isNewerVersion-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">isNewerVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;currentValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Compares the value with the value from the object (or cache).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#setUsesServerTime-boolean-">setUsesServerTime</a></span>(boolean&nbsp;usesServerTime)</code>
<div class="block">PUBLIC:
Set if policy uses server time.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#useLocalTime--">useLocalTime</a></span>()</code>
<div class="block">PUBLIC:
set this policy to get the time from the local machine.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#useServerTime--">useServerTime</a></span>()</code>
<div class="block">PUBLIC:
set this policy to get the time from the server.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#usesLocalTime--">usesLocalTime</a></span>()</code>
<div class="block">PUBLIC:
Return true if policy uses local time.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html#usesServerTime--">usesServerTime</a></span>()</code>
<div class="block">PUBLIC:
Return true if policy uses server time.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.descriptors.VersionLockingPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.descriptors.<a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></h3>
<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#addLockFieldsToUpdateRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">addLockFieldsToUpdateRow</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#addLockValuesToTranslationRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">addLockValuesToTranslationRow</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#buildDeleteExpression-org.eclipse.persistence.internal.helper.DatabaseTable-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildDeleteExpression</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#buildExpression--">buildExpression</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#buildUpdateExpression-org.eclipse.persistence.internal.helper.DatabaseTable-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildUpdateExpression</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#clone--">clone</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getDescriptor--">getDescriptor</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getLockOnChangeMode--">getLockOnChangeMode</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getUnmappedFields--">getUnmappedFields</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getVersionMapping--">getVersionMapping</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockField--">getWriteLockField</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockFieldName--">getWriteLockFieldName</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#initializeProperties--">initializeProperties</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isCascaded--">isCascaded</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isStoredInCache--">isStoredInCache</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isStoredInObject--">isStoredInObject</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockValueFromObject-java.lang.Object-">lockValueFromObject</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#mergeIntoParentCache-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.identitymaps.CacheKey-">mergeIntoParentCache</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#mergeIntoParentCache-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.lang.Object-java.lang.Object-">mergeIntoParentCache</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setIsCascaded-boolean-">setIsCascaded</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setIsStoredInCache-boolean-">setIsStoredInCache</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setLockOnChangeMode-org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange-">setLockOnChangeMode</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setupWriteFieldsForInsert-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">setupWriteFieldsForInsert</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setWriteLockField-org.eclipse.persistence.internal.helper.DatabaseField-">setWriteLockField</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setWriteLockFieldName-java.lang.String-">setWriteLockFieldName</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#shouldUpdateVersionOnMappingChange--">shouldUpdateVersionOnMappingChange</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#shouldUpdateVersionOnOwnedMappingChange--">shouldUpdateVersionOnOwnedMappingChange</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#storeInCache--">storeInCache</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#storeInObject--">storeInObject</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#supportsWriteLockValuesComparison--">supportsWriteLockValuesComparison</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateObjectWithWriteValue-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateObjectWithWriteValue</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateRowAndObjectForUpdate-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateRowAndObjectForUpdate</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateWriteLockValueForWrite-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateWriteLockValueForWrite</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#validateDelete-int-java.lang.Object-org.eclipse.persistence.queries.DeleteObjectQuery-">validateDelete</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#validateUpdate-int-java.lang.Object-org.eclipse.persistence.queries.WriteObjectQuery-">validateUpdate</a>, <a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#writeLockValueIntoRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">writeLockValueIntoRow</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="retrieveTimeFrom">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retrieveTimeFrom</h4>
<pre>protected&nbsp;int retrieveTimeFrom</pre>
</li>
</ul>
<a name="SERVER_TIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SERVER_TIME</h4>
<pre>public static final&nbsp;int SERVER_TIME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.TimestampLockingPolicy.SERVER_TIME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOCAL_TIME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOCAL_TIME</h4>
<pre>public static final&nbsp;int LOCAL_TIME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.TimestampLockingPolicy.LOCAL_TIME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TimestampLockingPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TimestampLockingPolicy</h4>
<pre>public&nbsp;TimestampLockingPolicy()</pre>
<div class="block">PUBLIC:
Create a new TimestampLockingPolicy.
Defaults to using the time retrieved from the server.</div>
</li>
</ul>
<a name="TimestampLockingPolicy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TimestampLockingPolicy</h4>
<pre>public&nbsp;TimestampLockingPolicy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fieldName)</pre>
<div class="block">PUBLIC:
Create a new TimestampLockingPolicy.
Defaults to using the time retrieved from the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldName</code> - the field where the write lock value will be stored.</dd>
</dl>
</li>
</ul>
<a name="TimestampLockingPolicy-org.eclipse.persistence.internal.helper.DatabaseField-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimestampLockingPolicy</h4>
<pre>public&nbsp;TimestampLockingPolicy(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;field)</pre>
<div class="block">INTERNAL:
Create a new TimestampLockingPolicy.
Defaults to using the time retrieved from the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - the field where the write lock value will be stored.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compareWriteLockValues-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareWriteLockValues</h4>
<pre>public&nbsp;int&nbsp;compareWriteLockValues(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value2)</pre>
<div class="block">INTERNAL:
This method compares two writeLockValues.
The writeLockValues should be non-null and of type java.sql.Timestamp.
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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareWriteLockValues</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#compareWriteLockValues-java.lang.Object-java.lang.Object-">compareWriteLockValues</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getDefaultLockingFieldType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultLockingFieldType</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getDefaultLockingFieldType()</pre>
<div class="block">INTERNAL:
Return the default timestamp locking filed java type, default is Timestamp.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getDefaultLockingFieldType--">getDefaultLockingFieldType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getBaseValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseValue</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getBaseValue()</pre>
<div class="block">INTERNAL:
This is the base value that is older than all other values, it is used in the place of
null in some situations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getBaseValue</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getBaseValue--">getBaseValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getInitialWriteValue-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialWriteValue</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getInitialWriteValue(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
returns the initial locking value</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getInitialWriteValue-org.eclipse.persistence.internal.sessions.AbstractSession-">getInitialWriteValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getNewLockValue-org.eclipse.persistence.queries.ModifyQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNewLockValue</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getNewLockValue(<a href="../../../../org/eclipse/persistence/queries/ModifyQuery.html" title="class in org.eclipse.persistence.queries">ModifyQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
Returns the new Timestamp value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getNewLockValue-org.eclipse.persistence.queries.ModifyQuery-">getNewLockValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getValueToPutInCache-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueToPutInCache</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getValueToPutInCache(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Return the value that should be stored in the identity map. If the value
is stored in the object, then return a null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getValueToPutInCache</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getValueToPutInCache-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">getValueToPutInCache</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getVersionDifference-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersionDifference</h4>
<pre>public&nbsp;int&nbsp;getVersionDifference(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;currentValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKeys,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Return the number of versions different between these objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getVersionDifference</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getVersionDifference-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getVersionDifference</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentValue</code> - the new lock value</dd>
<dd><code>domainObject</code> - the object containing the version to be compared to</dd>
<dd><code>primaryKeys</code> - a vector containing the primary keys of the domainObject</dd>
<dd><code>session</code> - the session to be used with the comparison</dd>
</dl>
</li>
</ul>
<a name="getWriteLockValue-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteLockValue</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getWriteLockValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
This method will return the optimistic lock value for the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getWriteLockValue</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockValue-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getWriteLockValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getWriteLockUpdateExpression-org.eclipse.persistence.expressions.ExpressionBuilder-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteLockUpdateExpression</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>&nbsp;getWriteLockUpdateExpression(<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a>&nbsp;builder,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Return an expression that updates the write lock</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getWriteLockUpdateExpression</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockUpdateExpression-org.eclipse.persistence.expressions.ExpressionBuilder-org.eclipse.persistence.internal.sessions.AbstractSession-">getWriteLockUpdateExpression</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="incrementWriteLockValue-java.lang.Number-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incrementWriteLockValue</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;incrementWriteLockValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a>&nbsp;numberValue)</pre>
<div class="block">INTERNAL:
Timestamp versioning should not be able to do this. Override the superclass behavior.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#incrementWriteLockValue-java.lang.Number-">incrementWriteLockValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="isNewerVersion-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewerVersion</h4>
<pre>public&nbsp;boolean&nbsp;isNewerVersion(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;currentValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Compares the value with the value from the object (or cache).
Will return true if the currentValue is newer than the domainObject.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isNewerVersion</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isNewerVersion-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">isNewerVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="isNewerVersion-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewerVersion</h4>
<pre>public&nbsp;boolean&nbsp;isNewerVersion(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;databaseRow,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;domainObject,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;primaryKey,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Compares the value from the row and from the object (or cache).
Will return true if the row is newer than the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isNewerVersion</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isNewerVersion-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">isNewerVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="isNewerVersion-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewerVersion</h4>
<pre>public&nbsp;boolean&nbsp;isNewerVersion(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;firstLockFieldValue,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;secondWriteLockFieldValue)</pre>
<div class="block">INTERNAL:
Compares two values.
Will return true if the firstLockFieldValue is newer than the secondWriteLockFieldValue.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isNewerVersion-java.lang.Object-java.lang.Object-">isNewerVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">VersionLockingPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="setUsesServerTime-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUsesServerTime</h4>
<pre>public&nbsp;void&nbsp;setUsesServerTime(boolean&nbsp;usesServerTime)</pre>
<div class="block">PUBLIC:
Set if policy uses server time.</div>
</li>
</ul>
<a name="useLocalTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useLocalTime</h4>
<pre>public&nbsp;void&nbsp;useLocalTime()</pre>
<div class="block">PUBLIC:
set this policy to get the time from the local machine.</div>
</li>
</ul>
<a name="useServerTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useServerTime</h4>
<pre>public&nbsp;void&nbsp;useServerTime()</pre>
<div class="block">PUBLIC:
set this policy to get the time from the server.</div>
</li>
</ul>
<a name="usesLocalTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usesLocalTime</h4>
<pre>public&nbsp;boolean&nbsp;usesLocalTime()</pre>
<div class="block">PUBLIC:
Return true if policy uses local time.</div>
</li>
</ul>
<a name="usesServerTime--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>usesServerTime</h4>
<pre>public&nbsp;boolean&nbsp;usesServerTime()</pre>
<div class="block">PUBLIC:
Return true if policy uses server time.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/descriptors/TimestampLockingPolicy.html" target="_top">Frames</a></li>
<li><a href="TimestampLockingPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>