| <!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 Thu Apr 08 02:07:18 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CMPPolicy (EclipseLink 3.0.1, API Reference)</title> |
| <meta name="date" content="2021-04-08"> |
| <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="CMPPolicy (EclipseLink 3.0.1, 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}; |
| 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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/ClassExtractor.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface 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/CMPPolicy.html" target="_top">Frames</a></li> |
| <li><a href="CMPPolicy.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><a href="#nested.class.summary">Nested</a> | </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 CMPPolicy" class="title">Class CMPPolicy</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.CMPPolicy</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></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd>org.eclipse.persistence.internal.jpa.CMP3Policy</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CMPPolicy</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 <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></pre> |
| <div class="block"><p> |
| <b>Description</b>: Place holder for CMP specific information. This class can be set on the ClassDescriptor.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><code>PessimisticLockingPolicy</code></a>, |
| <a href="../../../../serialized-form.html#org.eclipse.persistence.descriptors.CMPPolicy">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TopLink 10.1.3</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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a></span></code> |
| <div class="block">INTERNAL: |
| This is the interface used to encapsulate the the type of key class element</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyIsElementAccessor.html" title="class in org.eclipse.persistence.descriptors">CMPPolicy.KeyIsElementAccessor</a></span></code> |
| <div class="block">INTERNAL: |
| This class will be used when the keyClass is a primitive</div> |
| </td> |
| </tr> |
| </table> |
| </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>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#AFTER_EJBCREATE">AFTER_EJBCREATE</a></span></code> |
| <div class="block">issue SQL after ejbCreate but before ejbPostCreate</div> |
| </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/CMPPolicy.html#AFTER_EJBPOSTCREATE">AFTER_EJBPOSTCREATE</a></span></code> |
| <div class="block">issue SQL after ejbPostCreate</div> |
| </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/CMPPolicy.html#ALL_MODIFICATIONS">ALL_MODIFICATIONS</a></span></code> |
| <div class="block">defer all modifications, inserts and deletes included (default)</div> |
| </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/CMPPolicy.html#descriptor">descriptor</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#forceUpdate">forceUpdate</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/CMPPolicy.html#mappedClass">mappedClass</a></span></code> |
| <div class="block">Class originally mapped, before anything was generated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#modificationDeferralLevel">modificationDeferralLevel</a></span></code> |
| <div class="block">The object deferral level.</div> |
| </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/CMPPolicy.html#nonDeferredCreateTime">nonDeferredCreateTime</a></span></code> |
| <div class="block">This setting will allow customers to control when Toplink will issue the insert SQL for CMP beans.</div> |
| </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/CMPPolicy.html#NONE">NONE</a></span></code> |
| <div class="block">defer no changes</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#pessimisticLockingPolicy">pessimisticLockingPolicy</a></span></code> |
| <div class="block">Allow the bean to always be locked as it enters a new transaction.</div> |
| </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/CMPPolicy.html#UNDEFINED">UNDEFINED</a></span></code> |
| <div class="block">undefined if it is non-deferred issue sql at create</div> |
| </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/CMPPolicy.html#UPDATE_MODIFICATIONS">UPDATE_MODIFICATIONS</a></span></code> |
| <div class="block">defer updates</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#updateAllFields">updateAllFields</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/CMPPolicy.html#CMPPolicy--">CMPPolicy</a></span>()</code> </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><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html" title="class in org.eclipse.persistence.descriptors">CMPPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#clone--">clone</a></span>()</code> |
| <div class="block">INTERNAL: |
| Clone the CMPPolicy</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/CMPPolicy.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this object to actual class-based |
| settings.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/CMPPolicy.html#createBeanUsingKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">createBeanUsingKey</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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Use the key to create a bean and initialize its primary key fields.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/CMPPolicy.html#createPrimaryKeyFromId-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">createPrimaryKeyFromId</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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Use the key to create a EclipseLink primary key.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#createPrimaryKeyInstance-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">createPrimaryKeyInstance</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> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Create an instance of the Id class or value from the object.</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/CMPPolicy.html#createPrimaryKeyInstanceFromId-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">createPrimaryKeyInstanceFromId</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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Create an instance of the composite primary key class for the key object.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/CMPPolicy.html#createPrimaryKeyInstanceFromPrimaryKeyValues-org.eclipse.persistence.internal.sessions.AbstractSession-int:A-java.lang.Object...-">createPrimaryKeyInstanceFromPrimaryKeyValues</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| int[] elementIndex, |
| <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>... keyElements)</code> |
| <div class="block">INTERNAL: |
| Create an instance of the composite primary key class for the key object.</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/CMPPolicy.html#getClassInstance-java.lang.Class-">getClassInstance</a></span>(<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> cls)</code> |
| <div class="block">INTERNAL: |
| Return a new instance of the class provided.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getDeferModificationsUntilCommit--">getDeferModificationsUntilCommit</a></span>()</code> |
| <div class="block">ADVANCED: |
| This can be used to control when changes to objects are submitted to the database |
| This is only applicable to TopLink's CMP implementation and not available within |
| the core.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><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/CMPPolicy.html#getDescriptor--">getDescriptor</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getForceUpdate--">getForceUpdate</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return true if descriptor is set to always update all registered objects of this type</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getKeyClassFields--">getKeyClassFields</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><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/CMPPolicy.html#getMappedClass--">getMappedClass</a></span>()</code> |
| <div class="block">PUBLIC: |
| Answer the mapped class.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getNonDeferredCreateTime--">getNonDeferredCreateTime</a></span>()</code> |
| <div class="block">ADVANCED: |
| This setting is only available for CMP beans that are not being deferred.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getPessimisticLockingPolicy--">getPessimisticLockingPolicy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the policy for bean pessimistic locking</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><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/CMPPolicy.html#getPKClass--">getPKClass</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i16" 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/CMPPolicy.html#getPKClassInstance--">getPKClassInstance</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#getUpdateAllFields--">getUpdateAllFields</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return true if descriptor is set to update all fields for an object of this |
| type when an update occurs.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#hasPessimisticLockingPolicy--">hasPessimisticLockingPolicy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return true if bean pessimistic locking is configured</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#initialize-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Initialize the CMPPolicy settings.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#internalGetForceUpdate--">internalGetForceUpdate</a></span>()</code> |
| <div class="block">INTERNAL: |
| return internal tri-state value so we can decide whether to inherit or not at init time.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#internalGetUpdateAllFields--">internalGetUpdateAllFields</a></span>()</code> |
| <div class="block">INTERNAL: |
| return internal tri-state value so we can decide whether to inherit or not at init time.</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/CMPPolicy.html#internalSetForceUpdate-java.lang.Boolean-">internalSetForceUpdate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> newForceUpdateValue)</code> |
| <div class="block">INTERNAL: |
| internal method to set the tri-state value.</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/CMPPolicy.html#internalSetUpdateAllFields-java.lang.Boolean-">internalSetUpdateAllFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> newUpdateAllFieldsValue)</code> |
| <div class="block">INTERNAL: |
| internal method to set the tri-state value.</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/CMPPolicy.html#isCMP3Policy--">isCMP3Policy</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if this policy is for CMP3.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#isSingleKey-org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor:A-">isSingleKey</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a>[] pkElementArray)</code> |
| <div class="block">Check to see if there is a single key element.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#remoteInitialize-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">remoteInitialize</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Initialize the CMPPolicy settings for remote sessions.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#setDeferModificationsUntilCommit-int-">setDeferModificationsUntilCommit</a></span>(int deferralLevel)</code> |
| <div class="block">ADVANCED: |
| This can be set to control when changes to objects are submitted to the database |
| This is only applicable to TopLink's CMP implementation and not available within |
| the core.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.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> owningDescriptor)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#setFieldValue-org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor-java.lang.Object-org.eclipse.persistence.mappings.DatabaseMapping-org.eclipse.persistence.internal.sessions.AbstractSession-int:A-java.lang.Object...-">setFieldValue</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a> accessor, |
| <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> keyInstance, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| int[] elementIndex, |
| <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>... keyElements)</code> |
| <div class="block">INTERNAL: |
| Recursive method to set a field value in the given key instance.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html#setForceUpdate-boolean-">setForceUpdate</a></span>(boolean shouldForceUpdate)</code> |
| <div class="block">ADVANCED: |
| Configure whether TopLink should always update all registered objects of |
| this type.</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/CMPPolicy.html#setMappedClass-java.lang.Class-">setMappedClass</a></span>(<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> newMappedClass)</code> |
| <div class="block">PUBLIC: |
| Define the mapped class.</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/CMPPolicy.html#setNonDeferredCreateTime-int-">setNonDeferredCreateTime</a></span>(int createTime)</code> |
| <div class="block">ADVANCED: |
| This setting is only available for CMP beans that are not being deferred.</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/CMPPolicy.html#setPessimisticLockingPolicy-org.eclipse.persistence.descriptors.PessimisticLockingPolicy-">setPessimisticLockingPolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a> policy)</code> |
| <div class="block">PUBLIC: |
| Configure bean pessimistic locking</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/CMPPolicy.html#setUpdateAllFields-boolean-">setUpdateAllFields</a></span>(boolean shouldUpdatAllFields)</code> |
| <div class="block">ADVANCED: |
| Configure whether TopLink should update all fields for an object of this |
| type when an update occurs.</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="forceUpdate"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forceUpdate</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> forceUpdate</pre> |
| </li> |
| </ul> |
| <a name="updateAllFields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateAllFields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> updateAllFields</pre> |
| </li> |
| </ul> |
| <a name="pessimisticLockingPolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pessimisticLockingPolicy</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a> pessimisticLockingPolicy</pre> |
| <div class="block">Allow the bean to always be locked as it enters a new transaction.</div> |
| </li> |
| </ul> |
| <a name="mappedClass"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mappedClass</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> mappedClass</pre> |
| <div class="block">Class originally mapped, before anything was generated.</div> |
| </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="modificationDeferralLevel"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modificationDeferralLevel</h4> |
| <pre>protected int modificationDeferralLevel</pre> |
| <div class="block">The object deferral level. This controls when objects changes will be sent to the Database.</div> |
| </li> |
| </ul> |
| <a name="NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NONE</h4> |
| <pre>public static final int NONE</pre> |
| <div class="block">defer no changes</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.NONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="UPDATE_MODIFICATIONS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UPDATE_MODIFICATIONS</h4> |
| <pre>public static final int UPDATE_MODIFICATIONS</pre> |
| <div class="block">defer updates</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.UPDATE_MODIFICATIONS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ALL_MODIFICATIONS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ALL_MODIFICATIONS</h4> |
| <pre>public static final int ALL_MODIFICATIONS</pre> |
| <div class="block">defer all modifications, inserts and deletes included (default)</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.ALL_MODIFICATIONS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="nonDeferredCreateTime"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nonDeferredCreateTime</h4> |
| <pre>protected int nonDeferredCreateTime</pre> |
| <div class="block">This setting will allow customers to control when Toplink will issue the insert SQL for CMP beans.</div> |
| </li> |
| </ul> |
| <a name="UNDEFINED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNDEFINED</h4> |
| <pre>public static final int UNDEFINED</pre> |
| <div class="block">undefined if it is non-deferred issue sql at create</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.UNDEFINED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="AFTER_EJBCREATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AFTER_EJBCREATE</h4> |
| <pre>public static final int AFTER_EJBCREATE</pre> |
| <div class="block">issue SQL after ejbCreate but before ejbPostCreate</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.AFTER_EJBCREATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="AFTER_EJBPOSTCREATE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AFTER_EJBPOSTCREATE</h4> |
| <pre>public static final int AFTER_EJBPOSTCREATE</pre> |
| <div class="block">issue SQL after ejbPostCreate</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.descriptors.CMPPolicy.AFTER_EJBPOSTCREATE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CMPPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CMPPolicy</h4> |
| <pre>public CMPPolicy()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getNonDeferredCreateTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNonDeferredCreateTime</h4> |
| <pre>public int getNonDeferredCreateTime()</pre> |
| <div class="block">ADVANCED: |
| This setting is only available for CMP beans that are not being deferred. |
| Using it will allow TopLink to determine if the INSERT SQL should be sent to |
| the database before or after the postCreate call.</div> |
| </li> |
| </ul> |
| <a name="getPessimisticLockingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPessimisticLockingPolicy</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a> getPessimisticLockingPolicy()</pre> |
| <div class="block">PUBLIC: |
| Return the policy for bean pessimistic locking</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><code>PessimisticLockingPolicy</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDeferModificationsUntilCommit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeferModificationsUntilCommit</h4> |
| <pre>public void setDeferModificationsUntilCommit(int deferralLevel)</pre> |
| <div class="block">ADVANCED: |
| This can be set to control when changes to objects are submitted to the database |
| This is only applicable to TopLink's CMP implementation and not available within |
| the core.</div> |
| </li> |
| </ul> |
| <a name="setMappedClass-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMappedClass</h4> |
| <pre>public void setMappedClass(<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> newMappedClass)</pre> |
| <div class="block">PUBLIC: |
| Define the mapped class. This is the class which was originally mapped in the MW</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newMappedClass</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMappedClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedClass</h4> |
| <pre>public <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> getMappedClass()</pre> |
| <div class="block">PUBLIC: |
| Answer the mapped class. This is the class which was originally mapped in the MW</div> |
| </li> |
| </ul> |
| <a name="setNonDeferredCreateTime-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNonDeferredCreateTime</h4> |
| <pre>public void setNonDeferredCreateTime(int createTime)</pre> |
| <div class="block">ADVANCED: |
| This setting is only available for CMP beans that are not being deferred. |
| Using it will allow TopLink to determine if the INSERT SQL should be sent to |
| the database before or after the postCreate call.</div> |
| </li> |
| </ul> |
| <a name="setPessimisticLockingPolicy-org.eclipse.persistence.descriptors.PessimisticLockingPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPessimisticLockingPolicy</h4> |
| <pre>public void setPessimisticLockingPolicy(<a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors">PessimisticLockingPolicy</a> policy)</pre> |
| <div class="block">PUBLIC: |
| Configure bean pessimistic locking</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>policy</code> - </dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/PessimisticLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><code>PessimisticLockingPolicy</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasPessimisticLockingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPessimisticLockingPolicy</h4> |
| <pre>public boolean hasPessimisticLockingPolicy()</pre> |
| <div class="block">PUBLIC: |
| Return true if bean pessimistic locking is configured</div> |
| </li> |
| </ul> |
| <a name="getDeferModificationsUntilCommit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeferModificationsUntilCommit</h4> |
| <pre>public int getDeferModificationsUntilCommit()</pre> |
| <div class="block">ADVANCED: |
| This can be used to control when changes to objects are submitted to the database |
| This is only applicable to TopLink's CMP implementation and not available within |
| the core.</div> |
| </li> |
| </ul> |
| <a name="getForceUpdate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getForceUpdate</h4> |
| <pre>public boolean getForceUpdate()</pre> |
| <div class="block">ADVANCED: |
| Return true if descriptor is set to always update all registered objects of this type</div> |
| </li> |
| </ul> |
| <a name="setForceUpdate-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setForceUpdate</h4> |
| <pre>public void setForceUpdate(boolean shouldForceUpdate)</pre> |
| <div class="block">ADVANCED: |
| Configure whether TopLink should always update all registered objects of |
| this type. NOTE: if set to true, then updateAllFields must also be set |
| to true</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shouldForceUpdate</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdateAllFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdateAllFields</h4> |
| <pre>public boolean getUpdateAllFields()</pre> |
| <div class="block">ADVANCED: |
| Return true if descriptor is set to update all fields for an object of this |
| type when an update occurs.</div> |
| </li> |
| </ul> |
| <a name="setUpdateAllFields-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpdateAllFields</h4> |
| <pre>public void setUpdateAllFields(boolean shouldUpdatAllFields)</pre> |
| <div class="block">ADVANCED: |
| Configure whether TopLink should update all fields for an object of this |
| type when an update occurs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shouldUpdatAllFields</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="internalGetForceUpdate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>internalGetForceUpdate</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> internalGetForceUpdate()</pre> |
| <div class="block">INTERNAL: |
| return internal tri-state value so we can decide whether to inherit or not at init time.</div> |
| </li> |
| </ul> |
| <a name="internalGetUpdateAllFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>internalGetUpdateAllFields</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> internalGetUpdateAllFields()</pre> |
| <div class="block">INTERNAL: |
| return internal tri-state value so we can decide whether to inherit or not at init time.</div> |
| </li> |
| </ul> |
| <a name="internalSetForceUpdate-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>internalSetForceUpdate</h4> |
| <pre>public void internalSetForceUpdate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> newForceUpdateValue)</pre> |
| <div class="block">INTERNAL: |
| internal method to set the tri-state value. This is done in InheritancePolicy at init time.</div> |
| </li> |
| </ul> |
| <a name="internalSetUpdateAllFields-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>internalSetUpdateAllFields</h4> |
| <pre>public void internalSetUpdateAllFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> newUpdateAllFieldsValue)</pre> |
| <div class="block">INTERNAL: |
| internal method to set the tri-state value. This is done in InheritancePolicy at init time.</div> |
| </li> |
| </ul> |
| <a name="initialize-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Initialize the CMPPolicy settings.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remoteInitialize-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteInitialize</h4> |
| <pre>public void remoteInitialize(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Initialize the CMPPolicy settings for remote sessions.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> getDescriptor()</pre> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the owningDescriptor.</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> owningDescriptor)</pre> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>owningDescriptor</code> - The owningDescriptor to set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFieldValue-org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor-java.lang.Object-org.eclipse.persistence.mappings.DatabaseMapping-org.eclipse.persistence.internal.sessions.AbstractSession-int:A-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFieldValue</h4> |
| <pre>protected void setFieldValue(<a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a> accessor, |
| <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> keyInstance, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| int[] elementIndex, |
| <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>... keyElements)</pre> |
| <div class="block">INTERNAL: |
| Recursive method to set a field value in the given key instance.</div> |
| </li> |
| </ul> |
| <a name="isCMP3Policy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCMP3Policy</h4> |
| <pre>public boolean isCMP3Policy()</pre> |
| <div class="block">INTERNAL: |
| Return if this policy is for CMP3.</div> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.html" title="class in org.eclipse.persistence.descriptors">CMPPolicy</a> clone()</pre> |
| <div class="block">INTERNAL: |
| Clone the CMPPolicy</div> |
| <dl> |
| <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="convertClassNamesToClasses-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertClassNamesToClasses</h4> |
| <pre>public void convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this object to actual class-based |
| settings. This method is used when converting a project that has been built |
| with class names to a project with classes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoader</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createPrimaryKeyInstanceFromId-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPrimaryKeyInstanceFromId</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> createPrimaryKeyInstanceFromId(<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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Create an instance of the composite primary key class for the key object.</div> |
| </li> |
| </ul> |
| <a name="createPrimaryKeyInstanceFromPrimaryKeyValues-org.eclipse.persistence.internal.sessions.AbstractSession-int:A-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPrimaryKeyInstanceFromPrimaryKeyValues</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> createPrimaryKeyInstanceFromPrimaryKeyValues(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| int[] elementIndex, |
| <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>... keyElements)</pre> |
| <div class="block">INTERNAL: |
| Create an instance of the composite primary key class for the key object. |
| Yes the elementIndex looks strange but this is just a simple way to get the index to be pass-by-reference</div> |
| </li> |
| </ul> |
| <a name="createPrimaryKeyInstance-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPrimaryKeyInstance</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> createPrimaryKeyInstance(<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, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Create an instance of the Id class or value from the object.</div> |
| </li> |
| </ul> |
| <a name="getClassInstance-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassInstance</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> getClassInstance(<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> cls)</pre> |
| <div class="block">INTERNAL: |
| Return a new instance of the class provided.</div> |
| </li> |
| </ul> |
| <a name="getPKClassInstance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPKClassInstance</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> getPKClassInstance()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="getPKClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPKClass</h4> |
| <pre>public <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> getPKClass()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="createPrimaryKeyFromId-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPrimaryKeyFromId</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> createPrimaryKeyFromId(<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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Use the key to create a EclipseLink primary key. |
| If the key is simple (direct mapped) then just add it to a vector, |
| otherwise must go through the inefficient process of copying the key into the bean |
| and extracting the key from the bean.</div> |
| </li> |
| </ul> |
| <a name="createBeanUsingKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createBeanUsingKey</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> createBeanUsingKey(<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> key, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Use the key to create a bean and initialize its primary key fields. |
| Note: If is a compound PK then a primary key object is being used. |
| This method should only be used for 'templates' when executing |
| queries. The bean built will not be given an EntityContext and should |
| not be used as an actual entity bean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - Object the primary key to use for initializing the bean's |
| corresponding pk fields</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyClassFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyClassFields</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a>[] getKeyClassFields()</pre> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the keyClassFields.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSingleKey-org.eclipse.persistence.descriptors.CMPPolicy.KeyElementAccessor:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isSingleKey</h4> |
| <pre>protected boolean isSingleKey(<a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface in org.eclipse.persistence.descriptors">CMPPolicy.KeyElementAccessor</a>[] pkElementArray)</pre> |
| <div class="block">Check to see if there is a single key element. Iterate through the list of primary key elements |
| and count only keys that are not part of the Multitenant identifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pkElementArray</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/ClassExtractor.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/CMPPolicy.KeyElementAccessor.html" title="interface 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/CMPPolicy.html" target="_top">Frames</a></li> |
| <li><a href="CMPPolicy.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><a href="#nested.class.summary">Nested</a> | </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> |