| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:40 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>OpenJPAStateManager (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OpenJPAStateManager (OpenJPA Parent POM 2.4.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/OpenJPAStateManager.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/OpenJPASavepoint.html" title="class in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/OrderingMergedResultObjectProvider.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/OpenJPAStateManager.html" target="_top">Frames</a></li> |
| <li><a href="OpenJPAStateManager.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>Constr | </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>Constr | </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.apache.openjpa.kernel</div> |
| <h2 title="Interface OpenJPAStateManager" class="title">Interface OpenJPAStateManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html" title="interface in org.apache.openjpa.enhance">FieldConsumer</a>, <a href="../../../../org/apache/openjpa/enhance/FieldManager.html" title="interface in org.apache.openjpa.enhance">FieldManager</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/DetachedStateManager.html" title="class in org.apache.openjpa.kernel">DetachedStateManager</a>, <a href="../../../../org/apache/openjpa/kernel/DetachedValueStateManager.html" title="class in org.apache.openjpa.kernel">DetachedValueStateManager</a>, <a href="../../../../org/apache/openjpa/kernel/ObjectIdStateManager.html" title="class in org.apache.openjpa.kernel">ObjectIdStateManager</a>, <a href="../../../../org/apache/openjpa/kernel/StateManagerImpl.html" title="class in org.apache.openjpa.kernel">StateManagerImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">OpenJPAStateManager</span> |
| extends <a href="../../../../org/apache/openjpa/enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a>, <a href="../../../../org/apache/openjpa/enhance/FieldManager.html" title="interface in org.apache.openjpa.enhance">FieldManager</a></pre> |
| <div class="block">Interface implemented by OpenJPA state managers. Each state manager |
| manages the state of a single persistence capable instance. The |
| state manager is also responsible for all communications about the |
| instance to the <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><code>StoreManager</code></a>. |
| The <code>fetchXXXField</code> and <code>storeXXXField</code> |
| methods can be used to get and set fields of the managed persistent object. |
| Most back-end code, however, should use the similar |
| <code>fetchXXX</code> and <code>storeXXX</code> methods in place of |
| the field methods. These methods function just like the field methods, but |
| also pass the value through the externalizer and factory the field may have.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" 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><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#SET_ATTACH">SET_ATTACH</a></strong></code> |
| <div class="block">The field is being attached by a detached state manager; the value is |
| from the detached instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#SET_REMOTE">SET_REMOTE</a></strong></code> |
| <div class="block">The remote broker framework is setting the field on the server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#SET_USER">SET_USER</a></strong></code> |
| <div class="block">A user is setting the field.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#assignObjectId(boolean)">assignObjectId</a></strong>(boolean flush)</code> |
| <div class="block">Ask the store manager to assign a permanent oid to this new instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#beforeRefresh(boolean)">beforeRefresh</a></strong>(boolean refreshAll)</code> |
| <div class="block">Prepare the instance for refresh</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#dirty(int)">dirty</a></strong>(int field)</code> |
| <div class="block">Mark the given field as dirty.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetch(int)">fetch</a></strong>(int field)</code> |
| <div class="block">Return the externalized value of the field with the given index as an |
| object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchBoolean(int)">fetchBoolean</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchByte(int)">fetchByte</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchChar(int)">fetchChar</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchDouble(int)">fetchDouble</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchField(int,%20boolean)">fetchField</a></strong>(int field, |
| boolean transitions)</code> |
| <div class="block">Return the value of the field with the given index as an object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchFloat(int)">fetchFloat</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchInitialField(int)">fetchInitialField</a></strong>(int field)</code> |
| <div class="block">Return the value of the field at the specified index as of the |
| beginning of the transaction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchInt(int)">fetchInt</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchLong(int)">fetchLong</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchObject(int)">fetchObject</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchObjectField(int)">fetchObjectField</a></strong>(int field)</code> |
| <div class="block">Fetch an object field by index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchShort(int)">fetchShort</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchString(int)">fetchString</a></strong>(int field)</code> |
| <div class="block">Return the external value of the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getContext()">getContext</a></strong>()</code> |
| <div class="block">Return the managing context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getDirty()">getDirty</a></strong>()</code> |
| <div class="block">Return a read-only mask of the indexes of all dirty fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getFlushed()">getFlushed</a></strong>()</code> |
| <div class="block">Return a read-only mask of the indexes of all fields that have been |
| flushed since they were last changed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getId()">getId</a></strong>()</code> |
| <div class="block">Return the identifier for this state manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getImplData()">getImplData</a></strong>()</code> |
| <div class="block">An object that concrete back ends can associate with each instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getImplData(int)">getImplData</a></strong>(int field)</code> |
| <div class="block">Field-level impl data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getIntermediate(int)">getIntermediate</a></strong>(int field)</code> |
| <div class="block">Use intermediate field data to store intermediate information that |
| might be available before the field is fully loaded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getLoaded()">getLoaded</a></strong>()</code> |
| <div class="block">Return a read-only mask of the indexes of all loaded fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getLock()">getLock</a></strong>()</code> |
| <div class="block">The lock object set for this instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getManagedInstance()">getManagedInstance</a></strong>()</code> |
| <div class="block">Return the managed instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getMetaData()">getMetaData</a></strong>()</code> |
| <div class="block">Get the metadata for this instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getObjectId()">getObjectId</a></strong>()</code> |
| <div class="block">Return the instance's object id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getOwner()">getOwner</a></strong>()</code> |
| <div class="block">Return the owning state if this is an embedded instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getOwnerIndex()">getOwnerIndex</a></strong>()</code> |
| <div class="block">Return the owning value's field index</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getPCState()">getPCState</a></strong>()</code> |
| <div class="block">Return the state that this object is in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getPersistenceCapable()">getPersistenceCapable</a></strong>()</code> |
| <div class="block">Return the <a href="../../../../org/apache/openjpa/enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance"><code>PersistenceCapable</code></a> instance that provides access to |
| the instance managed by this state manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getUnloaded(org.apache.openjpa.kernel.FetchConfiguration)">getUnloaded</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <div class="block">Return a mutable mask of the unloaded fields that need loading based |
| on the given fetch configuration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getVersion()">getVersion</a></strong>()</code> |
| <div class="block">Return the current version indicator for this instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#initialize(java.lang.Class,%20org.apache.openjpa.kernel.PCState)">initialize</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> forType, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state)</code> |
| <div class="block">Initialize the state manager with a new instance of the given |
| persistence capable type and the proper lifecycle state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isDefaultValue(int)">isDefaultValue</a></strong>(int field)</code> |
| <div class="block">Return true if the given field has a default value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isDelayed(int)">isDelayed</a></strong>(int field)</code> |
| <div class="block">Some field types (collection proxies) support delayed loading.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isEmbedded()">isEmbedded</a></strong>()</code> |
| <div class="block">Return true if this instance has an owner, meaning it is an embedded |
| value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isFlushed()">isFlushed</a></strong>()</code> |
| <div class="block">Return whether this object has been flushed to the datastore in this |
| transaction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isFlushedDirty()">isFlushedDirty</a></strong>()</code> |
| <div class="block">Return whether this object has been flushed, then dirtied again.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isImplDataCacheable()">isImplDataCacheable</a></strong>()</code> |
| <div class="block">Whether the instance-level impl data can be shared among instances |
| in different contexts if L2 caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isImplDataCacheable(int)">isImplDataCacheable</a></strong>(int field)</code> |
| <div class="block">Whether the field's impl data is loaded and can be shared among |
| instances in different contexts if L2 caching is enabled.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isProvisional()">isProvisional</a></strong>()</code> |
| <div class="block">Return whether this object is provisionally persistent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isVersionCheckRequired()">isVersionCheckRequired</a></strong>()</code> |
| <div class="block">Returns true if this state needs to issue a version check at flush time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#isVersionUpdateRequired()">isVersionUpdateRequired</a></strong>()</code> |
| <div class="block">Returns true if this state needs to issue a version update, possibly |
| as a result of being locked.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#load(org.apache.openjpa.kernel.FetchConfiguration)">load</a></strong>(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</code> |
| <div class="block">Load fetch group fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#loadDelayedField(int)">loadDelayedField</a></strong>(int field)</code> |
| <div class="block">If a field was marked delayed in a previous load operation this method can be |
| used to load the field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#newFieldProxy(int)">newFieldProxy</a></strong>(int field)</code> |
| <div class="block">Create a new hollow proxy instance for the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#newProxy(int)">newProxy</a></strong>(int field)</code> |
| <div class="block">Create a new hollow proxy instance for the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#removed(int,%20java.lang.Object,%20boolean)">removed</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> removed, |
| boolean key)</code> |
| <div class="block">Notification that an element has been removed from the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setDelayed(int,%20boolean)">setDelayed</a></strong>(int field, |
| boolean delay)</code> |
| <div class="block">Some field types (collection proxies) support delayed loading.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(int,%20java.lang.Object)">setImplData</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</code> |
| <div class="block">Field-level impl data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(java.lang.Object,%20boolean)">setImplData</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data, |
| boolean cacheable)</code> |
| <div class="block">An object that concrete back ends can associate with each instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setIntermediate(int,%20java.lang.Object)">setIntermediate</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Use intermediate field data to store intermediate information that |
| might be available before the field is fully loaded.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setLock(java.lang.Object)">setLock</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> lock)</code> |
| <div class="block">The lock object set for this instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setNextVersion(java.lang.Object)">setNextVersion</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> version)</code> |
| <div class="block">Set the next version indicator in the datastore pending a successful |
| flush.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setObjectId(java.lang.Object)">setObjectId</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</code> |
| <div class="block">Set the object id for the managed instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setRemote(int,%20java.lang.Object)">setRemote</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set the given field to the given value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setVersion(java.lang.Object)">setVersion</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> version)</code> |
| <div class="block">Set the version indicator for this instance, as loaded from the |
| data store.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#store(int,%20java.lang.Object)">store</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set the value of the field with the given index as from the external |
| object value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeBoolean(int,%20boolean)">storeBoolean</a></strong>(int field, |
| boolean externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeByte(int,%20byte)">storeByte</a></strong>(int field, |
| byte externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeChar(int,%20char)">storeChar</a></strong>(int field, |
| char externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeDouble(int,%20double)">storeDouble</a></strong>(int field, |
| double externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeField(int,%20java.lang.Object)">storeField</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Set the value of the field with the given index as an object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeFloat(int,%20float)">storeFloat</a></strong>(int field, |
| float externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeInt(int,%20int)">storeInt</a></strong>(int field, |
| int externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeLong(int,%20long)">storeLong</a></strong>(int field, |
| long externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeObject(int,%20java.lang.Object)">storeObject</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeShort(int,%20short)">storeShort</a></strong>(int field, |
| short externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeString(int,%20java.lang.String)">storeString</a></strong>(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalVal)</code> |
| <div class="block">Set the given external value back into the given field.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.enhance.StateManager"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.enhance.<a href="../../../../org/apache/openjpa/enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></h3> |
| <code><a href="../../../../org/apache/openjpa/enhance/StateManager.html#accessingField(int)">accessingField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#dirty(java.lang.String)">dirty</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#fetchObjectId()">fetchObjectId</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#getGenericContext()">getGenericContext</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#getPCPrimaryKey(java.lang.Object,%20int)">getPCPrimaryKey</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isDeleted()">isDeleted</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isDetached()">isDetached</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isDirty()">isDirty</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isNew()">isNew</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isPersistent()">isPersistent</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#isTransactional()">isTransactional</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedBooleanField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20boolean)">providedBooleanField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedByteField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20byte)">providedByteField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedCharField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20char)">providedCharField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedDoubleField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20double)">providedDoubleField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedFloatField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20float)">providedFloatField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedIntField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20int)">providedIntField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedLongField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20long)">providedLongField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedObjectField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20java.lang.Object)">providedObjectField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedShortField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20short)">providedShortField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#providedStringField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20java.lang.String)">providedStringField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#proxyDetachedDeserialized(int)">proxyDetachedDeserialized</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceBooleanField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceBooleanField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceByteField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceByteField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceCharField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceCharField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceDoubleField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceDoubleField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceFloatField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceFloatField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceIntField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceIntField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceLongField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceLongField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceObjectField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceObjectField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceShortField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceShortField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceStateManager(org.apache.openjpa.enhance.StateManager)">replaceStateManager</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#replaceStringField(org.apache.openjpa.enhance.PersistenceCapable,%20int)">replaceStringField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#serializing()">serializing</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingBooleanField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20boolean,%20boolean,%20int)">settingBooleanField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingByteField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20byte,%20byte,%20int)">settingByteField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingCharField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20char,%20char,%20int)">settingCharField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingDoubleField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20double,%20double,%20int)">settingDoubleField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingFloatField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20float,%20float,%20int)">settingFloatField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingIntField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20int,%20int,%20int)">settingIntField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingLongField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20long,%20long,%20int)">settingLongField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingObjectField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20java.lang.Object,%20java.lang.Object,%20int)">settingObjectField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingShortField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20short,%20short,%20int)">settingShortField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#settingStringField(org.apache.openjpa.enhance.PersistenceCapable,%20int,%20java.lang.String,%20java.lang.String,%20int)">settingStringField</a>, <a href="../../../../org/apache/openjpa/enhance/StateManager.html#writeDetached(java.io.ObjectOutput)">writeDetached</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.enhance.FieldConsumer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.enhance.<a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html" title="interface in org.apache.openjpa.enhance">FieldConsumer</a></h3> |
| <code><a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeBooleanField(int,%20boolean)">storeBooleanField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeByteField(int,%20byte)">storeByteField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeCharField(int,%20char)">storeCharField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeDoubleField(int,%20double)">storeDoubleField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeFloatField(int,%20float)">storeFloatField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeIntField(int,%20int)">storeIntField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeLongField(int,%20long)">storeLongField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeObjectField(int,%20java.lang.Object)">storeObjectField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeShortField(int,%20short)">storeShortField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldConsumer.html#storeStringField(int,%20java.lang.String)">storeStringField</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.enhance.FieldSupplier"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.enhance.<a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></h3> |
| <code><a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchBooleanField(int)">fetchBooleanField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchByteField(int)">fetchByteField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchCharField(int)">fetchCharField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchDoubleField(int)">fetchDoubleField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchFloatField(int)">fetchFloatField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchIntField(int)">fetchIntField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchLongField(int)">fetchLongField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchShortField(int)">fetchShortField</a>, <a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchStringField(int)">fetchStringField</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="SET_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SET_USER</h4> |
| <pre>static final int SET_USER</pre> |
| <div class="block">A user is setting the field.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.OpenJPAStateManager.SET_USER">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="SET_REMOTE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SET_REMOTE</h4> |
| <pre>static final int SET_REMOTE</pre> |
| <div class="block">The remote broker framework is setting the field on the server.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.OpenJPAStateManager.SET_REMOTE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="SET_ATTACH"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SET_ATTACH</h4> |
| <pre>static final int SET_ATTACH</pre> |
| <div class="block">The field is being attached by a detached state manager; the value is |
| from the detached instance.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.OpenJPAStateManager.SET_ATTACH">Constant Field Values</a></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="initialize(java.lang.Class, org.apache.openjpa.kernel.PCState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>void initialize(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> forType, |
| <a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> state)</pre> |
| <div class="block">Initialize the state manager with a new instance of the given |
| persistence capable type and the proper lifecycle state. |
| Invoking this method may change the object id and metadata for the |
| state manager, as the concrete type specified in the parameter may be |
| a subclass of the expected type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>forType</code> - the type for which to create a new instance</dd><dd><code>state</code> - the initial state to which to set the instance</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="load(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>void load(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Load fetch group fields.</div> |
| </li> |
| </ul> |
| <a name="getManagedInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedInstance</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getManagedInstance()</pre> |
| <div class="block">Return the managed instance.</div> |
| </li> |
| </ul> |
| <a name="getPersistenceCapable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistenceCapable</h4> |
| <pre><a href="../../../../org/apache/openjpa/enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a> getPersistenceCapable()</pre> |
| <div class="block">Return the <a href="../../../../org/apache/openjpa/enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance"><code>PersistenceCapable</code></a> instance that provides access to |
| the instance managed by this state manager. May be a proxy around |
| the actual managed instance.</div> |
| </li> |
| </ul> |
| <a name="getMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getMetaData()</pre> |
| <div class="block">Get the metadata for this instance.</div> |
| </li> |
| </ul> |
| <a name="getOwner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOwner</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> getOwner()</pre> |
| <div class="block">Return the owning state if this is an embedded instance.</div> |
| </li> |
| </ul> |
| <a name="getOwnerIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOwnerIndex</h4> |
| <pre>int getOwnerIndex()</pre> |
| <div class="block">Return the owning value's field index</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isEmbedded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbedded</h4> |
| <pre>boolean isEmbedded()</pre> |
| <div class="block">Return true if this instance has an owner, meaning it is an embedded |
| value.</div> |
| </li> |
| </ul> |
| <a name="isFlushed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFlushed</h4> |
| <pre>boolean isFlushed()</pre> |
| <div class="block">Return whether this object has been flushed to the datastore in this |
| transaction.</div> |
| </li> |
| </ul> |
| <a name="isFlushedDirty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFlushedDirty</h4> |
| <pre>boolean isFlushedDirty()</pre> |
| <div class="block">Return whether this object has been flushed, then dirtied again.</div> |
| </li> |
| </ul> |
| <a name="isProvisional()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProvisional</h4> |
| <pre>boolean isProvisional()</pre> |
| <div class="block">Return whether this object is provisionally persistent.</div> |
| </li> |
| </ul> |
| <a name="getLoaded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoaded</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> getLoaded()</pre> |
| <div class="block">Return a read-only mask of the indexes of all loaded fields.</div> |
| </li> |
| </ul> |
| <a name="getDirty()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDirty</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> getDirty()</pre> |
| <div class="block">Return a read-only mask of the indexes of all dirty fields.</div> |
| </li> |
| </ul> |
| <a name="getFlushed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushed</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> getFlushed()</pre> |
| <div class="block">Return a read-only mask of the indexes of all fields that have been |
| flushed since they were last changed.</div> |
| </li> |
| </ul> |
| <a name="getUnloaded(org.apache.openjpa.kernel.FetchConfiguration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnloaded</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util">BitSet</a> getUnloaded(<a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> fetch)</pre> |
| <div class="block">Return a mutable mask of the unloaded fields that need loading based |
| on the given fetch configuration. Pass in null to retrieve all |
| unloaded fields.</div> |
| </li> |
| </ul> |
| <a name="newProxy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newProxy</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newProxy(int field)</pre> |
| <div class="block">Create a new hollow proxy instance for the given field. In cases where |
| the field externalizes to an SCO but is declared something else, the |
| returned object may not implement <a href="../../../../org/apache/openjpa/util/Proxy.html" title="interface in org.apache.openjpa.util"><code>Proxy</code></a>. In all other cases, |
| this method delegates to the system |
| <a href="../../../../org/apache/openjpa/util/ProxyManager.html" title="interface in org.apache.openjpa.util"><code>ProxyManager</code></a> |
| with the correct field information. The returned proxy's owner is |
| unset so that modifications to the proxy will not be tracked while its |
| state is initialized. Calling <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeField(int,%20java.lang.Object)"><code>storeField(int, java.lang.Object)</code></a> or <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#store(int,%20java.lang.Object)"><code>store(int, java.lang.Object)</code></a> |
| will set the proxy's owner automatically.</div> |
| </li> |
| </ul> |
| <a name="newFieldProxy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newFieldProxy</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newFieldProxy(int field)</pre> |
| <div class="block">Create a new hollow proxy instance for the given field. This method |
| differs from <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#newProxy(int)"><code>newProxy(int)</code></a> in that it returns a proxy for the |
| field's declared type, not its externalized type.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#newProxy(int)"><code>newProxy(int)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isDefaultValue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultValue</h4> |
| <pre>boolean isDefaultValue(int field)</pre> |
| <div class="block">Return true if the given field has a default value.</div> |
| </li> |
| </ul> |
| <a name="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getContext()</pre> |
| <div class="block">Return the managing context.</div> |
| </li> |
| </ul> |
| <a name="getPCState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCState</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/PCState.html" title="class in org.apache.openjpa.kernel">PCState</a> getPCState()</pre> |
| <div class="block">Return the state that this object is in.</div> |
| </li> |
| </ul> |
| <a name="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getId()</pre> |
| <div class="block">Return the identifier for this state manager. This may return a |
| temporary identifier for new unflushed instances that have not been |
| assigned an object id, or for non-persistent or embedded instances. |
| For all other instances this method is the same as <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#getObjectId()"><code>getObjectId()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getObjectId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectId</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getObjectId()</pre> |
| <div class="block">Return the instance's object id. This method will return null if no |
| oid has been assigned. Oids are assigned to newly-persisted instances |
| when the user first asks for it, or on flush.</div> |
| </li> |
| </ul> |
| <a name="setObjectId(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObjectId</h4> |
| <pre>void setObjectId(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oid)</pre> |
| <div class="block">Set the object id for the managed instance. Some back ends may not be |
| able to assign a permanent oid until flush. Do not call this method on |
| application identity instances; changing the primary key fields of |
| application identity objects through the <code>storeXXXField</code> |
| methods will automatically change the oid.</div> |
| </li> |
| </ul> |
| <a name="assignObjectId(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignObjectId</h4> |
| <pre>boolean assignObjectId(boolean flush)</pre> |
| <div class="block">Ask the store manager to assign a permanent oid to this new instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>flush</code> - if true, flush if necessary to get a permanent oid; if |
| false, the oid may be left unassigned</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if an oid assigned, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="getLock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLock</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getLock()</pre> |
| <div class="block">The lock object set for this instance. This object is generally |
| managed by the system lock manager.</div> |
| </li> |
| </ul> |
| <a name="setLock(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLock</h4> |
| <pre>void setLock(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> lock)</pre> |
| <div class="block">The lock object set for this instance. This object is generally |
| managed by the system lock manager.</div> |
| </li> |
| </ul> |
| <a name="getVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getVersion()</pre> |
| <div class="block">Return the current version indicator for this instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/enhance/StateManager.html#getVersion()">getVersion</a></code> in interface <code><a href="../../../../org/apache/openjpa/enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVersion(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre>void setVersion(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> version)</pre> |
| <div class="block">Set the version indicator for this instance, as loaded from the |
| data store. This method is used by the <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><code>StoreManager</code></a> when |
| loading instance data. On rollback, the version will be rolled back |
| to this value. Version objects should be serializable and should not |
| require vendor-specific classes, because they are transferred to |
| detached objects.</div> |
| </li> |
| </ul> |
| <a name="setNextVersion(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNextVersion</h4> |
| <pre>void setNextVersion(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> version)</pre> |
| <div class="block">Set the next version indicator in the datastore pending a successful |
| flush. The <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><code>StoreManager</code></a> uses this method during flush.</div> |
| </li> |
| </ul> |
| <a name="isVersionUpdateRequired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVersionUpdateRequired</h4> |
| <pre>boolean isVersionUpdateRequired()</pre> |
| <div class="block">Returns true if this state needs to issue a version update, possibly |
| as a result of being locked.</div> |
| </li> |
| </ul> |
| <a name="isVersionCheckRequired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVersionCheckRequired</h4> |
| <pre>boolean isVersionCheckRequired()</pre> |
| <div class="block">Returns true if this state needs to issue a version check at flush time.</div> |
| </li> |
| </ul> |
| <a name="getImplData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImplData</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getImplData()</pre> |
| <div class="block">An object that concrete back ends can associate with each instance. |
| This object is not used or modified in any way by the generic |
| persistence layer.</div> |
| </li> |
| </ul> |
| <a name="setImplData(java.lang.Object, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setImplData</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> setImplData(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data, |
| boolean cacheable)</pre> |
| <div class="block">An object that concrete back ends can associate with each instance. |
| This object is not used or modified in any way by the generic |
| persistence layer.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheable</code> - whether the impl data can be shared among instances |
| in different contexts if L2 caching is enabled</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the previous impl data value, if any</dd></dl> |
| </li> |
| </ul> |
| <a name="isImplDataCacheable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isImplDataCacheable</h4> |
| <pre>boolean isImplDataCacheable()</pre> |
| <div class="block">Whether the instance-level impl data can be shared among instances |
| in different contexts if L2 caching is enabled.</div> |
| </li> |
| </ul> |
| <a name="getImplData(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getImplData</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getImplData(int field)</pre> |
| <div class="block">Field-level impl data. Field-level data only applies to loaded fields, |
| and is cleared when the field is cleared.</div> |
| </li> |
| </ul> |
| <a name="setImplData(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setImplData</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> setImplData(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> data)</pre> |
| <div class="block">Field-level impl data. Field-level data only applies to loaded fields, |
| and is cleared when the field is cleared. Whether the data is cached |
| across instances depends on the corresponding field metadata's response |
| to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesImplData()"><code>FieldMetaData.usesImplData()</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the previous impl data value, if any</dd></dl> |
| </li> |
| </ul> |
| <a name="isImplDataCacheable(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isImplDataCacheable</h4> |
| <pre>boolean isImplDataCacheable(int field)</pre> |
| <div class="block">Whether the field's impl data is loaded and can be shared among |
| instances in different contexts if L2 caching is enabled.</div> |
| </li> |
| </ul> |
| <a name="getIntermediate(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntermediate</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getIntermediate(int field)</pre> |
| <div class="block">Use intermediate field data to store intermediate information that |
| might be available before the field is fully loaded. The system |
| will automatically clear this data when the field gets loaded. |
| This data should be cacheable; the datastore cache will attempt to |
| cache it if the field value is not available.</div> |
| </li> |
| </ul> |
| <a name="setIntermediate(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIntermediate</h4> |
| <pre>void setIntermediate(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Use intermediate field data to store intermediate information that |
| might be available before the field is fully loaded. The system |
| will automatically clear this data when the field gets loaded. |
| This data should be cacheable; the datastore cache will attempt to |
| cache it if the field value is not available.</div> |
| </li> |
| </ul> |
| <a name="fetchBoolean(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchBoolean</h4> |
| <pre>boolean fetchBoolean(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchByte(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchByte</h4> |
| <pre>byte fetchByte(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchChar(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchChar</h4> |
| <pre>char fetchChar(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchDouble(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchDouble</h4> |
| <pre>double fetchDouble(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchFloat(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchFloat</h4> |
| <pre>float fetchFloat(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchInt(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchInt</h4> |
| <pre>int fetchInt(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchLong(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchLong</h4> |
| <pre>long fetchLong(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchObject(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchObject</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fetchObject(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchShort(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchShort</h4> |
| <pre>short fetchShort(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetchString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchString</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fetchString(int field)</pre> |
| <div class="block">Return the external value of the given field.</div> |
| </li> |
| </ul> |
| <a name="fetch(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetch</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fetch(int field)</pre> |
| <div class="block">Return the externalized value of the field with the given index as an |
| object. If there is no externalizer, this is equivalent to |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#fetchField(int,%20boolean)"><code>fetchField(int, boolean)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="fetchField(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchField</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fetchField(int field, |
| boolean transitions)</pre> |
| <div class="block">Return the value of the field with the given index as an object.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>transitions</code> - if true, this method will cause state transitions |
| to occur as if the field were accessed normally</dd></dl> |
| </li> |
| </ul> |
| <a name="fetchInitialField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchInitialField</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fetchInitialField(int field)</pre> |
| <div class="block">Return the value of the field at the specified index as of the |
| beginning of the transaction.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="storeBoolean(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeBoolean</h4> |
| <pre>void storeBoolean(int field, |
| boolean externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeByte(int, byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeByte</h4> |
| <pre>void storeByte(int field, |
| byte externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeChar(int, char)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeChar</h4> |
| <pre>void storeChar(int field, |
| char externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeDouble(int, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeDouble</h4> |
| <pre>void storeDouble(int field, |
| double externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeFloat(int, float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeFloat</h4> |
| <pre>void storeFloat(int field, |
| float externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeInt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeInt</h4> |
| <pre>void storeInt(int field, |
| int externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeLong(int, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeLong</h4> |
| <pre>void storeLong(int field, |
| long externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeObject(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeObject</h4> |
| <pre>void storeObject(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeShort(int, short)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeShort</h4> |
| <pre>void storeShort(int field, |
| short externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="storeString(int, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeString</h4> |
| <pre>void storeString(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> externalVal)</pre> |
| <div class="block">Set the given external value back into the given field.</div> |
| </li> |
| </ul> |
| <a name="store(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>store</h4> |
| <pre>void store(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Set the value of the field with the given index as from the external |
| object value. If there is no externalizer, this is equivalent to |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#storeField(int,%20java.lang.Object)"><code>storeField(int, java.lang.Object)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="storeField(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeField</h4> |
| <pre>void storeField(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Set the value of the field with the given index as an object.</div> |
| </li> |
| </ul> |
| <a name="dirty(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dirty</h4> |
| <pre>void dirty(int field)</pre> |
| <div class="block">Mark the given field as dirty.</div> |
| </li> |
| </ul> |
| <a name="removed(int, java.lang.Object, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removed</h4> |
| <pre>void removed(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> removed, |
| boolean key)</pre> |
| <div class="block">Notification that an element has been removed from the given field.</div> |
| </li> |
| </ul> |
| <a name="beforeRefresh(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beforeRefresh</h4> |
| <pre>boolean beforeRefresh(boolean refreshAll)</pre> |
| <div class="block">Prepare the instance for refresh</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>refreshAll</code> - true if this instance is one of a collection of |
| objects being refreshed</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the object needs a refresh, false otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/Broker.html#refresh(java.lang.Object,%20org.apache.openjpa.kernel.OpCallbacks)"><code>Broker.refresh(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setRemote(int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRemote</h4> |
| <pre>void setRemote(int field, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Set the given field to the given value. Make the field dirty as |
| if user code set it. Do not delete dependent objects in the field's |
| current value. This method is invoked by the remote package to |
| synch a server-side state manager with remote changes. We do not |
| need to delete dependent instances because they will have been |
| deleted when the field changed on the client side, and those |
| client-side deletes will be transmitted independently.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="isDelayed(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDelayed</h4> |
| <pre>boolean isDelayed(int field)</pre> |
| <div class="block">Some field types (collection proxies) support delayed loading. Delayed loading |
| is a step beyond lazy loading. Delayed load allows an instance of a field to be |
| returned without actually loading it.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if the field is setup for delayed access</dd></dl> |
| </li> |
| </ul> |
| <a name="setDelayed(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDelayed</h4> |
| <pre>void setDelayed(int field, |
| boolean delay)</pre> |
| <div class="block">Some field types (collection proxies) support delayed loading. Delayed loading |
| is a step beyond lazy loading. Delayed load allows an instance of a field to be |
| returned without actually loading it.</div> |
| </li> |
| </ul> |
| <a name="loadDelayedField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadDelayedField</h4> |
| <pre>void loadDelayedField(int field)</pre> |
| <div class="block">If a field was marked delayed in a previous load operation this method can be |
| used to load the field.</div> |
| </li> |
| </ul> |
| <a name="fetchObjectField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fetchObjectField</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> fetchObjectField(int field)</pre> |
| <div class="block">Fetch an object field by index.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html#fetchObjectField(int)">fetchObjectField</a></code> in interface <code><a href="../../../../org/apache/openjpa/enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/OpenJPAStateManager.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/OpenJPASavepoint.html" title="class in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/OrderingMergedResultObjectProvider.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/OpenJPAStateManager.html" target="_top">Frames</a></li> |
| <li><a href="OpenJPAStateManager.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>Constr | </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>Constr | </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 © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |