| <!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>VersionLockingPolicy (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="VersionLockingPolicy (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,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":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/TimestampLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/VPDMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/descriptors/VersionLockingPolicy.html" target="_top">Frames</a></li> |
| <li><a href="VersionLockingPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 VersionLockingPolicy" class="title">Class VersionLockingPolicy</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>org.eclipse.persistence.descriptors.VersionLockingPolicy</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> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/TimestampLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">TimestampLockingPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">VersionLockingPolicy</span> |
| extends <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> |
| implements org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy, <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></pre> |
| <div class="block"><p><b>Purpose</b>: Used to allow a single version number 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.VersionLockingPolicy">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 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"> </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>protected <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/VersionLockingPolicy.html#cachedExpression">cachedExpression</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#descriptor">descriptor</a></span></code> </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/VersionLockingPolicy.html#IN_CACHE">IN_CACHE</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#IN_OBJECT">IN_OBJECT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isCascaded">isCascaded</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockMapping">lockMapping</a></span></code> |
| <div class="block">PERF: Cache the lock mapping if mapped with a direct mapping.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#lockOnChangeMode">lockOnChangeMode</a></span></code> </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/VersionLockingPolicy.html#lockValueStored">lockValueStored</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.helper.DatabaseField</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#writeLockField">writeLockField</a></span></code> </td> |
| </tr> |
| </table> |
| </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"> </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/VersionLockingPolicy.html#VersionLockingPolicy--">VersionLockingPolicy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#VersionLockingPolicy-org.eclipse.persistence.internal.helper.DatabaseField-">VersionLockingPolicy</a></span>(org.eclipse.persistence.internal.helper.DatabaseField field)</code> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#VersionLockingPolicy-java.lang.String-">VersionLockingPolicy</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> fieldName)</code> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#addLockFieldsToUpdateRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">addLockFieldsToUpdateRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Add update fields for template row.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#addLockValuesToTranslationRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">addLockValuesToTranslationRow</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| This method adds the lock value to the translation row of the |
| passed in query.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/VersionLockingPolicy.html#buildDeleteExpression-org.eclipse.persistence.internal.helper.DatabaseTable-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildDeleteExpression</a></span>(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> mainExpression, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</code> |
| <div class="block">INTERNAL: |
| When given an expression, this method will return a new expression with |
| the optimistic locking values included.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <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/VersionLockingPolicy.html#buildExpression--">buildExpression</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns an expression that will be used for both the update and |
| delete where clause</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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/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></span>(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> mainExpression, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row2)</code> |
| <div class="block">INTERNAL: |
| When given an expression, this method will return a new expression |
| with the optimistic locking values included.</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/VersionLockingPolicy.html#clone--">clone</a></span>()</code> |
| <div class="block">INTERNAL: |
| Clone the policy</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/VersionLockingPolicy.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> 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> value2)</code> |
| <div class="block">INTERNAL: |
| This method compares two writeLockValues.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/VersionLockingPolicy.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="i8" 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/VersionLockingPolicy.html#getDefaultLockingFieldType--">getDefaultLockingFieldType</a></span>()</code> |
| <div class="block">INTERNAL: |
| |
| Return the default version locking filed java type, default is BigDecimal</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getDescriptor--">getDescriptor</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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/VersionLockingPolicy.html#getInitialWriteValue-org.eclipse.persistence.internal.sessions.AbstractSession-">getInitialWriteValue</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| returns the initial locking value</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getLockOnChangeMode--">getLockOnChangeMode</a></span>()</code> |
| <div class="block">ADVANCED: |
| returns the LockOnChange mode for this policy.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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/VersionLockingPolicy.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> query)</code> |
| <div class="block">INTERNAL: |
| This method gets the write lock value from either the cache or |
| the object stored in the query.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getUnmappedFields--">getUnmappedFields</a></span>()</code> |
| <div class="block">INTERNAL: |
| This method returns any of the fields that are not mapped in |
| the object.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/VersionLockingPolicy.html#getValueToPutInCache-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">getValueToPutInCache</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Return the value that should be stored in the identity map.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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> 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> 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> primaryKeys, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">PUBLIC: |
| Return the number of versions different between these objects.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getVersionMapping--">getVersionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns the mapping that will be used to access the version value from an object.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseField</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockField--">getWriteLockField</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the write lock field.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#getWriteLockFieldName--">getWriteLockFieldName</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the field name of the field that stores the write lock value.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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/VersionLockingPolicy.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> builder, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Retrun an expression that updates the write lock</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/VersionLockingPolicy.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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| This method will return the optimistic lock value for the object</div> |
| </td> |
| </tr> |
| <tr id="i21" 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/VersionLockingPolicy.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> numberValue)</code> |
| <div class="block">INTERNAL: |
| Adds 1 to the value passed in.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| It is responsible for initializing the policy;</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#initializeProperties--">initializeProperties</a></span>()</code> |
| <div class="block">INTERNAL: |
| It is responsible for initializing the policy properties;</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isCascaded--">isCascaded</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return true if the policy uses cascade locking.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span>(org.eclipse.persistence.internal.sessions.AbstractRecord 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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Compares the value from the row and from the object (or cache).</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.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> 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> secondWriteLockFieldValue)</code> |
| <div class="block">INTERNAL: |
| Compares two values.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></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> 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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Compares the value with the value from the object (or cache).</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isStoredInCache--">isStoredInCache</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return true if the lock value is stored in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#isStoredInObject--">isStoredInObject</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return true if the lock value is stored in the object.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <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/VersionLockingPolicy.html#lockValueFromObject-java.lang.Object-">lockValueFromObject</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> domainObject)</code> |
| <div class="block">INTERNAL: |
| Retrieves the lock value from the object.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#mergeIntoParentCache-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.identitymaps.CacheKey-">mergeIntoParentCache</a></span>(org.eclipse.persistence.internal.identitymaps.CacheKey unitOfWorkCacheKey, |
| org.eclipse.persistence.internal.identitymaps.CacheKey parentSessionCacheKey)</code> |
| <div class="block">INTERNAL: |
| This method should merge changes from the parent into the child.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#mergeIntoParentCache-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.lang.Object-java.lang.Object-">mergeIntoParentCache</a></span>(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <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> primaryKey, |
| <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> object)</code> |
| <div class="block">INTERNAL: |
| Only applicable when the value is stored in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setIsCascaded-boolean-">setIsCascaded</a></span>(boolean isCascaded)</code> |
| <div class="block">PUBLIC: |
| Set whether to use cascade locking on the policy.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setIsStoredInCache-boolean-">setIsStoredInCache</a></span>(boolean isStoredInCache)</code> |
| <div class="block">PUBLIC: |
| Set whether to store the lock in the cache or in the object.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setLockOnChangeMode-org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange-">setLockOnChangeMode</a></span>(org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange lockOnChangeMode)</code> |
| <div class="block">ADVANCED: |
| Sets the LockOnChange mode for this policy.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setupWriteFieldsForInsert-org.eclipse.persistence.queries.ObjectLevelModifyQuery-">setupWriteFieldsForInsert</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| This method must be included in any locking policy.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setWriteLockField-org.eclipse.persistence.internal.helper.DatabaseField-">setWriteLockField</a></span>(org.eclipse.persistence.internal.helper.DatabaseField writeLockField)</code> |
| <div class="block">ADVANCED: |
| Set the write lock field.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#setWriteLockFieldName-java.lang.String-">setWriteLockFieldName</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> writeLockFieldName)</code> |
| <div class="block">PUBLIC: |
| Set the write lock field name.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#shouldUpdateVersionOnMappingChange--">shouldUpdateVersionOnMappingChange</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns true if the policy has been set to set an optimistic read lock when any mapping changes.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#shouldUpdateVersionOnOwnedMappingChange--">shouldUpdateVersionOnOwnedMappingChange</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns true if the policy has been set to set an optimistic read lock when a owning mapping changes.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#storeInCache--">storeInCache</a></span>()</code> |
| <div class="block">PUBLIC: |
| Configure the version lock value to be stored in the cache.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#storeInObject--">storeInObject</a></span>()</code> |
| <div class="block">PUBLIC: |
| Configure the version lock value to be stored in the object.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#supportsWriteLockValuesComparison--">supportsWriteLockValuesComparison</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates that compareWriteLockValues method is supported by the policy.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateObjectWithWriteValue-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateObjectWithWriteValue</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> lockValue)</code> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateRowAndObjectForUpdate-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateRowAndObjectForUpdate</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> domainObject)</code> |
| <div class="block">INTERNAL: |
| This method updates the modify row, and the domain object |
| with the new lock value.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#updateWriteLockValueForWrite-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">updateWriteLockValueForWrite</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> lockValue)</code> |
| <div class="block">INTERNAL: |
| Update the row, object and change set with the version value.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#validateDelete-int-java.lang.Object-org.eclipse.persistence.queries.DeleteObjectQuery-">validateDelete</a></span>(int rowCount, |
| <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> object, |
| <a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| Check the row count for lock failure.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#validateUpdate-int-java.lang.Object-org.eclipse.persistence.queries.WriteObjectQuery-">validateUpdate</a></span>(int rowCount, |
| <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> object, |
| <a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| Check the row count for lock failure.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/VersionLockingPolicy.html#writeLockValueIntoRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-">writeLockValueIntoRow</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> domainObject)</code> |
| <div class="block">INTERNAL: |
| This method updates the modify row with the old lock value.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="writeLockField"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLockField</h4> |
| <pre>protected org.eclipse.persistence.internal.helper.DatabaseField writeLockField</pre> |
| </li> |
| </ul> |
| <a name="isCascaded"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCascaded</h4> |
| <pre>protected boolean isCascaded</pre> |
| </li> |
| </ul> |
| <a name="lockValueStored"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockValueStored</h4> |
| <pre>protected int lockValueStored</pre> |
| </li> |
| </ul> |
| <a name="descriptor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptor</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor</pre> |
| </li> |
| </ul> |
| <a name="cachedExpression"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cachedExpression</h4> |
| <pre>protected transient <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> cachedExpression</pre> |
| </li> |
| </ul> |
| <a name="IN_CACHE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IN_CACHE</h4> |
| <pre>public static final int IN_CACHE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.VersionLockingPolicy.IN_CACHE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IN_OBJECT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IN_OBJECT</h4> |
| <pre>public static final int IN_OBJECT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.VersionLockingPolicy.IN_OBJECT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lockMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockMapping</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a> lockMapping</pre> |
| <div class="block">PERF: Cache the lock mapping if mapped with a direct mapping.</div> |
| </li> |
| </ul> |
| <a name="lockOnChangeMode"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>lockOnChangeMode</h4> |
| <pre>protected org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange lockOnChangeMode</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="VersionLockingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VersionLockingPolicy</h4> |
| <pre>public VersionLockingPolicy()</pre> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy. Defaults to |
| storing the lock value in the cache.</div> |
| </li> |
| </ul> |
| <a name="VersionLockingPolicy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VersionLockingPolicy</h4> |
| <pre>public VersionLockingPolicy(<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> fieldName)</pre> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy. Defaults to |
| storing the lock value in the cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - specifies the field name for the write |
| lock field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="VersionLockingPolicy-org.eclipse.persistence.internal.helper.DatabaseField-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VersionLockingPolicy</h4> |
| <pre>public VersionLockingPolicy(org.eclipse.persistence.internal.helper.DatabaseField field)</pre> |
| <div class="block">PUBLIC: |
| Create a new VersionLockingPolicy. Defaults to |
| storing the lock value in the cache.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>field</code> - the write lock field.</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="addLockFieldsToUpdateRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLockFieldsToUpdateRow</h4> |
| <pre>public void addLockFieldsToUpdateRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Add update fields for template row. |
| These are any unmapped fields required to write in an update.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>addLockFieldsToUpdateRow</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLockValuesToTranslationRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLockValuesToTranslationRow</h4> |
| <pre>public void addLockValuesToTranslationRow(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| This method adds the lock value to the translation row of the |
| passed in query. depending on the storage flag, the value is |
| either retrieved from the cache of the object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>addLockValuesToTranslationRow</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildDeleteExpression-org.eclipse.persistence.internal.helper.DatabaseTable-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildDeleteExpression</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildDeleteExpression(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> mainExpression, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</pre> |
| <div class="block">INTERNAL: |
| When given an expression, this method will return a new expression with |
| the optimistic locking values included. The values are taken from the |
| passed in database row. This expression will be used in a delete call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>buildDeleteExpression</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="buildExpression--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildExpression</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildExpression()</pre> |
| <div class="block">INTERNAL: |
| Returns an expression that will be used for both the update and |
| delete where clause</div> |
| </li> |
| </ul> |
| <a name="buildUpdateExpression-org.eclipse.persistence.internal.helper.DatabaseTable-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildUpdateExpression</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildUpdateExpression(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> mainExpression, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row2)</pre> |
| <div class="block">INTERNAL: |
| When given an expression, this method will return a new expression |
| with the optimistic locking values included. The values are taken |
| from the passed in database row. This expression will be used in |
| an update call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>buildUpdateExpression</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <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> clone()</pre> |
| <div class="block">INTERNAL: |
| Clone the policy</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>clone</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code> in class <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportsWriteLockValuesComparison--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsWriteLockValuesComparison</h4> |
| <pre>public boolean supportsWriteLockValuesComparison()</pre> |
| <div class="block">INTERNAL: |
| Indicates that compareWriteLockValues method is supported by the policy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>supportsWriteLockValuesComparison</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareWriteLockValues-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareWriteLockValues</h4> |
| <pre>public int 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> 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> value2)</pre> |
| <div class="block">INTERNAL: |
| This method compares two writeLockValues. |
| The writeLockValues should be non-null and of type Number. |
| 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultLockingFieldType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultLockingFieldType</h4> |
| <pre>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> getDefaultLockingFieldType()</pre> |
| <div class="block">INTERNAL: |
| |
| Return the default version locking filed java type, default is BigDecimal</div> |
| </li> |
| </ul> |
| <a name="getBaseValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBaseValue</h4> |
| <pre>public <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> 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> getDescriptor()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="getInitialWriteValue-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialWriteValue</h4> |
| <pre>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> getInitialWriteValue(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| returns the initial locking value</div> |
| </li> |
| </ul> |
| <a name="getLockOnChangeMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockOnChangeMode</h4> |
| <pre>public org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange getLockOnChangeMode()</pre> |
| <div class="block">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. |
| Unfortunately this locking policy can not enforce an optimistic write lock unless a FK or DTF field |
| has changed so this type returns LockOnChange.NONE</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getLockOnChangeMode</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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 <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> getNewLockValue(<a href="../../../../org/eclipse/persistence/queries/ModifyQuery.html" title="class in org.eclipse.persistence.queries">ModifyQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| This method gets the write lock value from either the cache or |
| the object stored in the query. It then returns the new incremented value.</div> |
| </li> |
| </ul> |
| <a name="getUnmappedFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnmappedFields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getUnmappedFields()</pre> |
| <div class="block">INTERNAL: |
| This method returns any of the fields that are not mapped in |
| the object. In the case of the value being stored in the |
| cache, a vector with one value is returned. In the case |
| of being stored in the object, an empty vector is returned.</div> |
| </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 <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> getValueToPutInCache(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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 int 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> 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> 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> primaryKeys, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">PUBLIC: |
| Return the number of versions different between these objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getVersionDifference</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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="getWriteLockField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockField</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseField getWriteLockField()</pre> |
| <div class="block">INTERNAL: |
| Return the write lock field.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getWriteLockField</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteLockFieldName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteLockFieldName</h4> |
| <pre>public <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> getWriteLockFieldName()</pre> |
| <div class="block">PUBLIC: |
| Return the field name of the field that stores the write lock value.</div> |
| </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 <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> getWriteLockUpdateExpression(<a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a> builder, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Retrun an expression that updates the write lock</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getWriteLockUpdateExpression</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></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 <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> 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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="incrementWriteLockValue-java.lang.Number-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incrementWriteLockValue</h4> |
| <pre>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> 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> numberValue)</pre> |
| <div class="block">INTERNAL: |
| Adds 1 to the value passed in.</div> |
| </li> |
| </ul> |
| <a name="initialize-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| It is responsible for initializing the policy;</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>initialize</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initializeProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeProperties</h4> |
| <pre>public void initializeProperties()</pre> |
| <div class="block">INTERNAL: |
| It is responsible for initializing the policy properties;</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>initializeProperties</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCascaded--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCascaded</h4> |
| <pre>public boolean isCascaded()</pre> |
| <div class="block">PUBLIC: |
| Return true if the policy uses cascade locking.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isCascaded</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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 boolean 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> 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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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 boolean isNewerVersion(org.eclipse.persistence.internal.sessions.AbstractRecord 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> 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> primaryKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession 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> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</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 boolean 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> 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> secondWriteLockFieldValue)</pre> |
| <div class="block">INTERNAL: |
| Compares two values. |
| Will return true if the firstLockFieldValue is newer than the secondWriteLockFieldValue.</div> |
| </li> |
| </ul> |
| <a name="isStoredInCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStoredInCache</h4> |
| <pre>public boolean isStoredInCache()</pre> |
| <div class="block">PUBLIC: |
| Return true if the lock value is stored in the cache.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isStoredInCache</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isStoredInObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStoredInObject</h4> |
| <pre>public boolean isStoredInObject()</pre> |
| <div class="block">PUBLIC: |
| Return true if the lock value is stored in the object.</div> |
| </li> |
| </ul> |
| <a name="lockValueFromObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockValueFromObject</h4> |
| <pre>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> lockValueFromObject(<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> domainObject)</pre> |
| <div class="block">INTERNAL: |
| Retrieves the lock value from the object.</div> |
| </li> |
| </ul> |
| <a name="getVersionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersionMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a> getVersionMapping()</pre> |
| <div class="block">INTERNAL: |
| Returns the mapping that will be used to access the version value from an object.</div> |
| </li> |
| </ul> |
| <a name="mergeIntoParentCache-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergeIntoParentCache</h4> |
| <pre>public void mergeIntoParentCache(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <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> primaryKey, |
| <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> object)</pre> |
| <div class="block">INTERNAL: |
| Only applicable when the value is stored in the cache. Will merge with the parent unit of work.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>mergeIntoParentCache</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="mergeIntoParentCache-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.identitymaps.CacheKey-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergeIntoParentCache</h4> |
| <pre>public void mergeIntoParentCache(org.eclipse.persistence.internal.identitymaps.CacheKey unitOfWorkCacheKey, |
| org.eclipse.persistence.internal.identitymaps.CacheKey parentSessionCacheKey)</pre> |
| <div class="block">INTERNAL: |
| This method should merge changes from the parent into the child. |
| |
| #see this method in VersionLockingPolicy</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>mergeIntoParentCache</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescriptor</h4> |
| <pre>public void setDescriptor(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</pre> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setDescriptor</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsStoredInCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsStoredInCache</h4> |
| <pre>public void setIsStoredInCache(boolean isStoredInCache)</pre> |
| <div class="block">PUBLIC: |
| Set whether to store the lock in the cache or in the object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isStoredInCache</code> - set this to true if you would like to store lock in the cache and set it |
| to false if you would like to store it in the object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsCascaded-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsCascaded</h4> |
| <pre>public void setIsCascaded(boolean isCascaded)</pre> |
| <div class="block">PUBLIC: |
| Set whether to use cascade locking on the policy.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isCascaded</code> - set this to true if you would like cascade the locking |
| and set it to false if you would like no cascade locking.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setupWriteFieldsForInsert-org.eclipse.persistence.queries.ObjectLevelModifyQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setupWriteFieldsForInsert</h4> |
| <pre>public void setupWriteFieldsForInsert(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| This method must be included in any locking policy. |
| Put the initial writelock value into the modifyRow.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setupWriteFieldsForInsert</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateWriteLockValueForWrite-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateWriteLockValueForWrite</h4> |
| <pre>protected void updateWriteLockValueForWrite(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> lockValue)</pre> |
| <div class="block">INTERNAL: |
| Update the row, object and change set with the version value. |
| This handles the version being mapped in nested aggregates, writable or read-only.</div> |
| </li> |
| </ul> |
| <a name="shouldUpdateVersionOnOwnedMappingChange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUpdateVersionOnOwnedMappingChange</h4> |
| <pre>public boolean shouldUpdateVersionOnOwnedMappingChange()</pre> |
| <div class="block">INTERNAL: |
| Returns true if the policy has been set to set an optimistic read lock when a owning mapping changes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>shouldUpdateVersionOnOwnedMappingChange</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldUpdateVersionOnMappingChange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUpdateVersionOnMappingChange</h4> |
| <pre>public boolean shouldUpdateVersionOnMappingChange()</pre> |
| <div class="block">INTERNAL: |
| Returns true if the policy has been set to set an optimistic read lock when any mapping changes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>shouldUpdateVersionOnMappingChange</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateObjectWithWriteValue-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateObjectWithWriteValue</h4> |
| <pre>public void updateObjectWithWriteValue(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> lockValue)</pre> |
| </li> |
| </ul> |
| <a name="setLockOnChangeMode-org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLockOnChangeMode</h4> |
| <pre>public void setLockOnChangeMode(org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange lockOnChangeMode)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setLockOnChangeMode</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWriteLockField-org.eclipse.persistence.internal.helper.DatabaseField-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockField</h4> |
| <pre>public void setWriteLockField(org.eclipse.persistence.internal.helper.DatabaseField writeLockField)</pre> |
| <div class="block">ADVANCED: |
| Set the write lock field. |
| This can be used for advanced field types, such as XML nodes, or to set the field type.</div> |
| </li> |
| </ul> |
| <a name="setWriteLockFieldName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWriteLockFieldName</h4> |
| <pre>public void setWriteLockFieldName(<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> writeLockFieldName)</pre> |
| <div class="block">PUBLIC: |
| Set the write lock field name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeLockFieldName</code> - the name of the field to lock against.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="storeInCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeInCache</h4> |
| <pre>public void storeInCache()</pre> |
| <div class="block">PUBLIC: |
| Configure the version lock value to be stored in the cache. |
| This allows for the object not to require to store its version value as an attribute. |
| Note: if using a stateless model where the object can be passed to a client and then |
| later updated in a different transaction context, then the version lock value should |
| not be stored in the cache, but in the object to ensure it is the correct value for |
| that object. This is the default.</div> |
| </li> |
| </ul> |
| <a name="storeInObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeInObject</h4> |
| <pre>public void storeInObject()</pre> |
| <div class="block">PUBLIC: |
| Configure the version lock value to be stored in the object. |
| The object must define a mapping and an attribute to store the version value. |
| Note: the value will be updated internally by EclipseLink and should not be updated |
| by the application.</div> |
| </li> |
| </ul> |
| <a name="updateRowAndObjectForUpdate-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateRowAndObjectForUpdate</h4> |
| <pre>public void updateRowAndObjectForUpdate(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> domainObject)</pre> |
| <div class="block">INTERNAL: |
| This method updates the modify row, and the domain object |
| with the new lock value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>updateRowAndObjectForUpdate</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeLockValueIntoRow-org.eclipse.persistence.queries.ObjectLevelModifyQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLockValueIntoRow</h4> |
| <pre>public void writeLockValueIntoRow(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| <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> domainObject)</pre> |
| <div class="block">INTERNAL: |
| This method updates the modify row with the old lock value.</div> |
| </li> |
| </ul> |
| <a name="validateDelete-int-java.lang.Object-org.eclipse.persistence.queries.DeleteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateDelete</h4> |
| <pre>public void validateDelete(int rowCount, |
| <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> object, |
| <a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| Check the row count for lock failure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>validateDelete</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateUpdate-int-java.lang.Object-org.eclipse.persistence.queries.WriteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validateUpdate</h4> |
| <pre>public void validateUpdate(int rowCount, |
| <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> object, |
| <a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| Check the row count for lock failure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>validateUpdate</code> in interface <code>org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy</code></dd> |
| </dl> |
| </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/TimestampLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/VPDMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/descriptors/VersionLockingPolicy.html" target="_top">Frames</a></li> |
| <li><a href="VersionLockingPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |