blob: a7fe79d6e14858eb98b62c02c47646af0f286802 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>OpenJPAStateManager (OpenJPA Parent POM 4.1.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OpenJPAStateManager (OpenJPA Parent POM 4.1.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.openjpa.kernel</a></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><code><a href="../enhance/FieldConsumer.html" title="interface in org.apache.openjpa.enhance">FieldConsumer</a></code>, <code><a href="../enhance/FieldManager.html" title="interface in org.apache.openjpa.enhance">FieldManager</a></code>, <code><a href="../enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></code>, <code><a href="../enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DetachedStateManager.html" title="class in org.apache.openjpa.kernel">DetachedStateManager</a></code>, <code><a href="DetachedValueStateManager.html" title="class in org.apache.openjpa.kernel">DetachedValueStateManager</a></code>, <code><a href="ObjectIdStateManager.html" title="class in org.apache.openjpa.kernel">ObjectIdStateManager</a></code>, <code><a href="StateManagerImpl.html" title="class in org.apache.openjpa.kernel">StateManagerImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">OpenJPAStateManager</span>
extends <a href="../enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a>, <a href="../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="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="simpleTagLabel">Author:</span></dt>
<dd>Abe White</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SET_ATTACH">SET_ATTACH</a></span></code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SET_REMOTE">SET_REMOTE</a></span></code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SET_USER">SET_USER</a></span></code></th>
<td class="colLast">
<div class="block">A user is setting the field.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assignObjectId(boolean)">assignObjectId</a></span>&#8203;(boolean&nbsp;flush)</code></th>
<td class="colLast">
<div class="block">Ask the store manager to assign a permanent oid to this new instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeRefresh(boolean)">beforeRefresh</a></span>&#8203;(boolean&nbsp;refreshAll)</code></th>
<td class="colLast">
<div class="block">Prepare the instance for refresh</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dirty(int)">dirty</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Mark the given field as dirty.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetch(int)">fetch</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the externalized value of the field with the given index as an
object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchBoolean(int)">fetchBoolean</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchByte(int)">fetchByte</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>char</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchChar(int)">fetchChar</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchDouble(int)">fetchDouble</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchField(int,boolean)">fetchField</a></span>&#8203;(int&nbsp;field,
boolean&nbsp;transitions)</code></th>
<td class="colLast">
<div class="block">Return the value of the field with the given index as an object.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchFloat(int)">fetchFloat</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchInitialField(int)">fetchInitialField</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the value of the field at the specified index as of the
beginning of the transaction.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchInt(int)">fetchInt</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchLong(int)">fetchLong</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchObject(int)">fetchObject</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchObjectField(int)">fetchObjectField</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Fetch an object field by index.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>short</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchShort(int)">fetchShort</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchString(int)">fetchString</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return the external value of the given field.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the managing context.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirty()">getDirty</a></span>()</code></th>
<td class="colLast">
<div class="block">Return a read-only mask of the indexes of all dirty fields.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushed()">getFlushed</a></span>()</code></th>
<td class="colLast">
<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 id="i20" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the identifier for this state manager.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImplData()">getImplData</a></span>()</code></th>
<td class="colLast">
<div class="block">An object that concrete back ends can associate with each instance.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImplData(int)">getImplData</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Field-level impl data.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntermediate(int)">getIntermediate</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<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 id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoaded()">getLoaded</a></span>()</code></th>
<td class="colLast">
<div class="block">Return a read-only mask of the indexes of all loaded fields.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLock()">getLock</a></span>()</code></th>
<td class="colLast">
<div class="block">The lock object set for this instance.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManagedInstance()">getManagedInstance</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the managed instance.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaData()">getMetaData</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the metadata for this instance.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectId()">getObjectId</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the instance's object id.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOwner()">getOwner</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the owning state if this is an embedded instance.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOwnerIndex()">getOwnerIndex</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the owning value's field index</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="PCState.html" title="class in org.apache.openjpa.kernel">PCState</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPCState()">getPCState</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the state that this object is in.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistenceCapable()">getPersistenceCapable</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the <a href="../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 id="i33" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnloaded(org.apache.openjpa.kernel.FetchConfiguration)">getUnloaded</a></span>&#8203;(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>&nbsp;fetch)</code></th>
<td class="colLast">
<div class="block">Return a mutable mask of the unloaded fields that need loading based
on the given fetch configuration.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the current version indicator for this instance.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(java.lang.Class,org.apache.openjpa.kernel.PCState)">initialize</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;forType,
<a href="PCState.html" title="class in org.apache.openjpa.kernel">PCState</a>&nbsp;state)</code></th>
<td class="colLast">
<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 id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDefaultValue(int)">isDefaultValue</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Return true if the given field has a default value.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDelayed(int)">isDelayed</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Some field types (collection proxies) support delayed loading.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmbedded()">isEmbedded</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if this instance has an owner, meaning it is an embedded
value.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFlushed()">isFlushed</a></span>()</code></th>
<td class="colLast">
<div class="block">Return whether this object has been flushed to the datastore in this
transaction.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFlushedDirty()">isFlushedDirty</a></span>()</code></th>
<td class="colLast">
<div class="block">Return whether this object has been flushed, then dirtied again.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isImplDataCacheable()">isImplDataCacheable</a></span>()</code></th>
<td class="colLast">
<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 id="i42" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isImplDataCacheable(int)">isImplDataCacheable</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<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 id="i43" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isProvisional()">isProvisional</a></span>()</code></th>
<td class="colLast">
<div class="block">Return whether this object is provisionally persistent.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isVersionCheckRequired()">isVersionCheckRequired</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if this state needs to issue a version check at flush time.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isVersionUpdateRequired()">isVersionUpdateRequired</a></span>()</code></th>
<td class="colLast">
<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 id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#load(org.apache.openjpa.kernel.FetchConfiguration)">load</a></span>&#8203;(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>&nbsp;fetch)</code></th>
<td class="colLast">
<div class="block">Load fetch group fields.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadDelayedField(int)">loadDelayedField</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<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 id="i48" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newFieldProxy(int)">newFieldProxy</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Create a new hollow proxy instance for the given field.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newProxy(int)">newProxy</a></span>&#8203;(int&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Create a new hollow proxy instance for the given field.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removed(int,java.lang.Object,boolean)">removed</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;removed,
boolean&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Notification that an element has been removed from the given field.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDelayed(int,boolean)">setDelayed</a></span>&#8203;(int&nbsp;field,
boolean&nbsp;delay)</code></th>
<td class="colLast">
<div class="block">Some field types (collection proxies) support delayed loading.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setImplData(int,java.lang.Object)">setImplData</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data)</code></th>
<td class="colLast">
<div class="block">Field-level impl data.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setImplData(java.lang.Object,boolean)">setImplData</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data,
boolean&nbsp;cacheable)</code></th>
<td class="colLast">
<div class="block">An object that concrete back ends can associate with each instance.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIntermediate(int,java.lang.Object)">setIntermediate</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<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 id="i55" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLock(java.lang.Object)">setLock</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;lock)</code></th>
<td class="colLast">
<div class="block">The lock object set for this instance.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNextVersion(java.lang.Object)">setNextVersion</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;version)</code></th>
<td class="colLast">
<div class="block">Set the next version indicator in the datastore pending a successful
flush.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setObjectId(java.lang.Object)">setObjectId</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;oid)</code></th>
<td class="colLast">
<div class="block">Set the object id for the managed instance.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRemote(int,java.lang.Object)">setRemote</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set the given field to the given value.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVersion(java.lang.Object)">setVersion</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;version)</code></th>
<td class="colLast">
<div class="block">Set the version indicator for this instance, as loaded from the
data store.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#store(int,java.lang.Object)">store</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set the value of the field with the given index as from the external
object value.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeBoolean(int,boolean)">storeBoolean</a></span>&#8203;(int&nbsp;field,
boolean&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeByte(int,byte)">storeByte</a></span>&#8203;(int&nbsp;field,
byte&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeChar(int,char)">storeChar</a></span>&#8203;(int&nbsp;field,
char&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeDouble(int,double)">storeDouble</a></span>&#8203;(int&nbsp;field,
double&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeField(int,java.lang.Object)">storeField</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set the value of the field with the given index as an object.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeFloat(int,float)">storeFloat</a></span>&#8203;(int&nbsp;field,
float&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeInt(int,int)">storeInt</a></span>&#8203;(int&nbsp;field,
int&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeLong(int,long)">storeLong</a></span>&#8203;(int&nbsp;field,
long&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeObject(int,java.lang.Object)">storeObject</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeShort(int,short)">storeShort</a></span>&#8203;(int&nbsp;field,
short&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#storeString(int,java.lang.String)">storeString</a></span>&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;externalVal)</code></th>
<td class="colLast">
<div class="block">Set the given external value back into the given field.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.enhance.FieldConsumer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.enhance.<a href="../enhance/FieldConsumer.html" title="interface in org.apache.openjpa.enhance">FieldConsumer</a></h3>
<code><a href="../enhance/FieldConsumer.html#storeBooleanField(int,boolean)">storeBooleanField</a>, <a href="../enhance/FieldConsumer.html#storeByteField(int,byte)">storeByteField</a>, <a href="../enhance/FieldConsumer.html#storeCharField(int,char)">storeCharField</a>, <a href="../enhance/FieldConsumer.html#storeDoubleField(int,double)">storeDoubleField</a>, <a href="../enhance/FieldConsumer.html#storeFloatField(int,float)">storeFloatField</a>, <a href="../enhance/FieldConsumer.html#storeIntField(int,int)">storeIntField</a>, <a href="../enhance/FieldConsumer.html#storeLongField(int,long)">storeLongField</a>, <a href="../enhance/FieldConsumer.html#storeObjectField(int,java.lang.Object)">storeObjectField</a>, <a href="../enhance/FieldConsumer.html#storeShortField(int,short)">storeShortField</a>, <a href="../enhance/FieldConsumer.html#storeStringField(int,java.lang.String)">storeStringField</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.enhance.FieldSupplier">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.enhance.<a href="../enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></h3>
<code><a href="../enhance/FieldSupplier.html#fetchBooleanField(int)">fetchBooleanField</a>, <a href="../enhance/FieldSupplier.html#fetchByteField(int)">fetchByteField</a>, <a href="../enhance/FieldSupplier.html#fetchCharField(int)">fetchCharField</a>, <a href="../enhance/FieldSupplier.html#fetchDoubleField(int)">fetchDoubleField</a>, <a href="../enhance/FieldSupplier.html#fetchFloatField(int)">fetchFloatField</a>, <a href="../enhance/FieldSupplier.html#fetchIntField(int)">fetchIntField</a>, <a href="../enhance/FieldSupplier.html#fetchLongField(int)">fetchLongField</a>, <a href="../enhance/FieldSupplier.html#fetchShortField(int)">fetchShortField</a>, <a href="../enhance/FieldSupplier.html#fetchStringField(int)">fetchStringField</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.enhance.StateManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.enhance.<a href="../enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></h3>
<code><a href="../enhance/StateManager.html#accessingField(int)">accessingField</a>, <a href="../enhance/StateManager.html#dirty(java.lang.String)">dirty</a>, <a href="../enhance/StateManager.html#fetchObjectId()">fetchObjectId</a>, <a href="../enhance/StateManager.html#getGenericContext()">getGenericContext</a>, <a href="../enhance/StateManager.html#getPCPrimaryKey(java.lang.Object,int)">getPCPrimaryKey</a>, <a href="../enhance/StateManager.html#isDeleted()">isDeleted</a>, <a href="../enhance/StateManager.html#isDetached()">isDetached</a>, <a href="../enhance/StateManager.html#isDirty()">isDirty</a>, <a href="../enhance/StateManager.html#isNew()">isNew</a>, <a href="../enhance/StateManager.html#isPersistent()">isPersistent</a>, <a href="../enhance/StateManager.html#isTransactional()">isTransactional</a>, <a href="../enhance/StateManager.html#providedBooleanField(org.apache.openjpa.enhance.PersistenceCapable,int,boolean)">providedBooleanField</a>, <a href="../enhance/StateManager.html#providedByteField(org.apache.openjpa.enhance.PersistenceCapable,int,byte)">providedByteField</a>, <a href="../enhance/StateManager.html#providedCharField(org.apache.openjpa.enhance.PersistenceCapable,int,char)">providedCharField</a>, <a href="../enhance/StateManager.html#providedDoubleField(org.apache.openjpa.enhance.PersistenceCapable,int,double)">providedDoubleField</a>, <a href="../enhance/StateManager.html#providedFloatField(org.apache.openjpa.enhance.PersistenceCapable,int,float)">providedFloatField</a>, <a href="../enhance/StateManager.html#providedIntField(org.apache.openjpa.enhance.PersistenceCapable,int,int)">providedIntField</a>, <a href="../enhance/StateManager.html#providedLongField(org.apache.openjpa.enhance.PersistenceCapable,int,long)">providedLongField</a>, <a href="../enhance/StateManager.html#providedObjectField(org.apache.openjpa.enhance.PersistenceCapable,int,java.lang.Object)">providedObjectField</a>, <a href="../enhance/StateManager.html#providedShortField(org.apache.openjpa.enhance.PersistenceCapable,int,short)">providedShortField</a>, <a href="../enhance/StateManager.html#providedStringField(org.apache.openjpa.enhance.PersistenceCapable,int,java.lang.String)">providedStringField</a>, <a href="../enhance/StateManager.html#proxyDetachedDeserialized(int)">proxyDetachedDeserialized</a>, <a href="../enhance/StateManager.html#replaceBooleanField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceBooleanField</a>, <a href="../enhance/StateManager.html#replaceByteField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceByteField</a>, <a href="../enhance/StateManager.html#replaceCharField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceCharField</a>, <a href="../enhance/StateManager.html#replaceDoubleField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceDoubleField</a>, <a href="../enhance/StateManager.html#replaceFloatField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceFloatField</a>, <a href="../enhance/StateManager.html#replaceIntField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceIntField</a>, <a href="../enhance/StateManager.html#replaceLongField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceLongField</a>, <a href="../enhance/StateManager.html#replaceObjectField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceObjectField</a>, <a href="../enhance/StateManager.html#replaceShortField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceShortField</a>, <a href="../enhance/StateManager.html#replaceStateManager(org.apache.openjpa.enhance.StateManager)">replaceStateManager</a>, <a href="../enhance/StateManager.html#replaceStringField(org.apache.openjpa.enhance.PersistenceCapable,int)">replaceStringField</a>, <a href="../enhance/StateManager.html#serializing()">serializing</a>, <a href="../enhance/StateManager.html#settingBooleanField(org.apache.openjpa.enhance.PersistenceCapable,int,boolean,boolean,int)">settingBooleanField</a>, <a href="../enhance/StateManager.html#settingByteField(org.apache.openjpa.enhance.PersistenceCapable,int,byte,byte,int)">settingByteField</a>, <a href="../enhance/StateManager.html#settingCharField(org.apache.openjpa.enhance.PersistenceCapable,int,char,char,int)">settingCharField</a>, <a href="../enhance/StateManager.html#settingDoubleField(org.apache.openjpa.enhance.PersistenceCapable,int,double,double,int)">settingDoubleField</a>, <a href="../enhance/StateManager.html#settingFloatField(org.apache.openjpa.enhance.PersistenceCapable,int,float,float,int)">settingFloatField</a>, <a href="../enhance/StateManager.html#settingIntField(org.apache.openjpa.enhance.PersistenceCapable,int,int,int,int)">settingIntField</a>, <a href="../enhance/StateManager.html#settingLongField(org.apache.openjpa.enhance.PersistenceCapable,int,long,long,int)">settingLongField</a>, <a href="../enhance/StateManager.html#settingObjectField(org.apache.openjpa.enhance.PersistenceCapable,int,java.lang.Object,java.lang.Object,int)">settingObjectField</a>, <a href="../enhance/StateManager.html#settingShortField(org.apache.openjpa.enhance.PersistenceCapable,int,short,short,int)">settingShortField</a>, <a href="../enhance/StateManager.html#settingStringField(org.apache.openjpa.enhance.PersistenceCapable,int,java.lang.String,java.lang.String,int)">settingStringField</a>, <a href="../enhance/StateManager.html#writeDetached(java.io.ObjectOutput)">writeDetached</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="SET_USER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET_USER</h4>
<pre>static final&nbsp;int SET_USER</pre>
<div class="block">A user is setting the field.</div>
<dl>
<dt><span class="seeLabel">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 id="SET_REMOTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SET_REMOTE</h4>
<pre>static final&nbsp;int SET_REMOTE</pre>
<div class="block">The remote broker framework is setting the field on the server.</div>
<dl>
<dt><span class="seeLabel">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 id="SET_ATTACH">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SET_ATTACH</h4>
<pre>static final&nbsp;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="seeLabel">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>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initialize(java.lang.Class,org.apache.openjpa.kernel.PCState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">void&nbsp;initialize&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;forType,
<a href="PCState.html" title="class in org.apache.openjpa.kernel">PCState</a>&nbsp;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="paramLabel">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="simpleTagLabel">Since:</span></dt>
<dd>0.3.1.2</dd>
</dl>
</li>
</ul>
<a id="load(org.apache.openjpa.kernel.FetchConfiguration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load</h4>
<pre class="methodSignature">void&nbsp;load&#8203;(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>&nbsp;fetch)</pre>
<div class="block">Load fetch group fields.</div>
</li>
</ul>
<a id="getManagedInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getManagedInstance</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getManagedInstance()</pre>
<div class="block">Return the managed instance.</div>
</li>
</ul>
<a id="getPersistenceCapable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistenceCapable</h4>
<pre class="methodSignature"><a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a>&nbsp;getPersistenceCapable()</pre>
<div class="block">Return the <a href="../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 id="getMetaData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaData</h4>
<pre class="methodSignature"><a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;getMetaData()</pre>
<div class="block">Get the metadata for this instance.</div>
</li>
</ul>
<a id="getOwner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwner</h4>
<pre class="methodSignature"><a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;getOwner()</pre>
<div class="block">Return the owning state if this is an embedded instance.</div>
</li>
</ul>
<a id="getOwnerIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnerIndex</h4>
<pre class="methodSignature">int&nbsp;getOwnerIndex()</pre>
<div class="block">Return the owning value's field index</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1.0</dd>
</dl>
</li>
</ul>
<a id="isEmbedded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmbedded</h4>
<pre class="methodSignature">boolean&nbsp;isEmbedded()</pre>
<div class="block">Return true if this instance has an owner, meaning it is an embedded
value.</div>
</li>
</ul>
<a id="isFlushed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFlushed</h4>
<pre class="methodSignature">boolean&nbsp;isFlushed()</pre>
<div class="block">Return whether this object has been flushed to the datastore in this
transaction.</div>
</li>
</ul>
<a id="isFlushedDirty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFlushedDirty</h4>
<pre class="methodSignature">boolean&nbsp;isFlushedDirty()</pre>
<div class="block">Return whether this object has been flushed, then dirtied again.</div>
</li>
</ul>
<a id="isProvisional()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isProvisional</h4>
<pre class="methodSignature">boolean&nbsp;isProvisional()</pre>
<div class="block">Return whether this object is provisionally persistent.</div>
</li>
</ul>
<a id="getLoaded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoaded</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>&nbsp;getLoaded()</pre>
<div class="block">Return a read-only mask of the indexes of all loaded fields.</div>
</li>
</ul>
<a id="getDirty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirty</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>&nbsp;getDirty()</pre>
<div class="block">Return a read-only mask of the indexes of all dirty fields.</div>
</li>
</ul>
<a id="getFlushed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlushed</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>&nbsp;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 id="getUnloaded(org.apache.openjpa.kernel.FetchConfiguration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnloaded</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>&nbsp;getUnloaded&#8203;(<a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>&nbsp;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 id="newProxy(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newProxy</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;newProxy&#8203;(int&nbsp;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="../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="../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="#storeField(int,java.lang.Object)"><code>storeField(int, java.lang.Object)</code></a> or <a href="#store(int,java.lang.Object)"><code>store(int, java.lang.Object)</code></a>
will set the proxy's owner automatically.</div>
</li>
</ul>
<a id="newFieldProxy(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newFieldProxy</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;newFieldProxy&#8203;(int&nbsp;field)</pre>
<div class="block">Create a new hollow proxy instance for the given field. This method
differs from <a href="#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="seeLabel">See Also:</span></dt>
<dd><a href="#newProxy(int)"><code>newProxy(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="isDefaultValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefaultValue</h4>
<pre class="methodSignature">boolean&nbsp;isDefaultValue&#8203;(int&nbsp;field)</pre>
<div class="block">Return true if the given field has a default value.</div>
</li>
</ul>
<a id="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre class="methodSignature"><a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a>&nbsp;getContext()</pre>
<div class="block">Return the managing context.</div>
</li>
</ul>
<a id="getPCState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPCState</h4>
<pre class="methodSignature"><a href="PCState.html" title="class in org.apache.openjpa.kernel">PCState</a>&nbsp;getPCState()</pre>
<div class="block">Return the state that this object is in.</div>
</li>
</ul>
<a id="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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="#getObjectId()"><code>getObjectId()</code></a>.</div>
</li>
</ul>
<a id="getObjectId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectId</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="setObjectId(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObjectId</h4>
<pre class="methodSignature">void&nbsp;setObjectId&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="assignObjectId(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignObjectId</h4>
<pre class="methodSignature">boolean&nbsp;assignObjectId&#8203;(boolean&nbsp;flush)</pre>
<div class="block">Ask the store manager to assign a permanent oid to this new instance.</div>
<dl>
<dt><span class="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>true if an oid assigned, false otherwise</dd>
</dl>
</li>
</ul>
<a id="getLock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLock</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="setLock(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLock</h4>
<pre class="methodSignature">void&nbsp;setLock&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="getVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getVersion()</pre>
<div class="block">Return the current version indicator for this instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../enhance/StateManager.html#getVersion()">getVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../enhance/StateManager.html" title="interface in org.apache.openjpa.enhance">StateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="setVersion(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersion</h4>
<pre class="methodSignature">void&nbsp;setVersion&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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="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 id="setNextVersion(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNextVersion</h4>
<pre class="methodSignature">void&nbsp;setNextVersion&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;version)</pre>
<div class="block">Set the next version indicator in the datastore pending a successful
flush. The <a href="StoreManager.html" title="interface in org.apache.openjpa.kernel"><code>StoreManager</code></a> uses this method during flush.</div>
</li>
</ul>
<a id="isVersionUpdateRequired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVersionUpdateRequired</h4>
<pre class="methodSignature">boolean&nbsp;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 id="isVersionCheckRequired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVersionCheckRequired</h4>
<pre class="methodSignature">boolean&nbsp;isVersionCheckRequired()</pre>
<div class="block">Returns true if this state needs to issue a version check at flush time.</div>
</li>
</ul>
<a id="getImplData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImplData</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="setImplData(java.lang.Object,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImplData</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;setImplData&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;data,
boolean&nbsp;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="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the previous impl data value, if any</dd>
</dl>
</li>
</ul>
<a id="isImplDataCacheable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isImplDataCacheable</h4>
<pre class="methodSignature">boolean&nbsp;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 id="getImplData(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImplData</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getImplData&#8203;(int&nbsp;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 id="setImplData(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImplData</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;setImplData&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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="../meta/FieldMetaData.html#usesImplData()"><code>FieldMetaData.usesImplData()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the previous impl data value, if any</dd>
</dl>
</li>
</ul>
<a id="isImplDataCacheable(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isImplDataCacheable</h4>
<pre class="methodSignature">boolean&nbsp;isImplDataCacheable&#8203;(int&nbsp;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 id="getIntermediate(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntermediate</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;getIntermediate&#8203;(int&nbsp;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 id="setIntermediate(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIntermediate</h4>
<pre class="methodSignature">void&nbsp;setIntermediate&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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 id="fetchBoolean(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchBoolean</h4>
<pre class="methodSignature">boolean&nbsp;fetchBoolean&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchByte(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchByte</h4>
<pre class="methodSignature">byte&nbsp;fetchByte&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchChar(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchChar</h4>
<pre class="methodSignature">char&nbsp;fetchChar&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchDouble(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchDouble</h4>
<pre class="methodSignature">double&nbsp;fetchDouble&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchFloat(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchFloat</h4>
<pre class="methodSignature">float&nbsp;fetchFloat&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchInt(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchInt</h4>
<pre class="methodSignature">int&nbsp;fetchInt&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchLong(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLong</h4>
<pre class="methodSignature">long&nbsp;fetchLong&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchObject(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchObject</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;fetchObject&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchShort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchShort</h4>
<pre class="methodSignature">short&nbsp;fetchShort&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetchString(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchString</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;fetchString&#8203;(int&nbsp;field)</pre>
<div class="block">Return the external value of the given field.</div>
</li>
</ul>
<a id="fetch(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetch</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;fetch&#8203;(int&nbsp;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="#fetchField(int,boolean)"><code>fetchField(int, boolean)</code></a>.</div>
</li>
</ul>
<a id="fetchField(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchField</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;fetchField&#8203;(int&nbsp;field,
boolean&nbsp;transitions)</pre>
<div class="block">Return the value of the field with the given index as an object.</div>
<dl>
<dt><span class="paramLabel">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 id="fetchInitialField(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchInitialField</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;fetchInitialField&#8203;(int&nbsp;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="simpleTagLabel">Since:</span></dt>
<dd>0.3.1.1</dd>
</dl>
</li>
</ul>
<a id="storeBoolean(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeBoolean</h4>
<pre class="methodSignature">void&nbsp;storeBoolean&#8203;(int&nbsp;field,
boolean&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeByte(int,byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeByte</h4>
<pre class="methodSignature">void&nbsp;storeByte&#8203;(int&nbsp;field,
byte&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeChar(int,char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeChar</h4>
<pre class="methodSignature">void&nbsp;storeChar&#8203;(int&nbsp;field,
char&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeDouble(int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeDouble</h4>
<pre class="methodSignature">void&nbsp;storeDouble&#8203;(int&nbsp;field,
double&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeFloat(int,float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeFloat</h4>
<pre class="methodSignature">void&nbsp;storeFloat&#8203;(int&nbsp;field,
float&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeInt(int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeInt</h4>
<pre class="methodSignature">void&nbsp;storeInt&#8203;(int&nbsp;field,
int&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeLong(int,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeLong</h4>
<pre class="methodSignature">void&nbsp;storeLong&#8203;(int&nbsp;field,
long&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeObject(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeObject</h4>
<pre class="methodSignature">void&nbsp;storeObject&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeShort(int,short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeShort</h4>
<pre class="methodSignature">void&nbsp;storeShort&#8203;(int&nbsp;field,
short&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="storeString(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeString</h4>
<pre class="methodSignature">void&nbsp;storeString&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;externalVal)</pre>
<div class="block">Set the given external value back into the given field.</div>
</li>
</ul>
<a id="store(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre class="methodSignature">void&nbsp;store&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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="#storeField(int,java.lang.Object)"><code>storeField(int, java.lang.Object)</code></a>.</div>
</li>
</ul>
<a id="storeField(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeField</h4>
<pre class="methodSignature">void&nbsp;storeField&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;value)</pre>
<div class="block">Set the value of the field with the given index as an object.</div>
</li>
</ul>
<a id="dirty(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirty</h4>
<pre class="methodSignature">void&nbsp;dirty&#8203;(int&nbsp;field)</pre>
<div class="block">Mark the given field as dirty.</div>
</li>
</ul>
<a id="removed(int,java.lang.Object,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removed</h4>
<pre class="methodSignature">void&nbsp;removed&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;removed,
boolean&nbsp;key)</pre>
<div class="block">Notification that an element has been removed from the given field.</div>
</li>
</ul>
<a id="beforeRefresh(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeRefresh</h4>
<pre class="methodSignature">boolean&nbsp;beforeRefresh&#8203;(boolean&nbsp;refreshAll)</pre>
<div class="block">Prepare the instance for refresh</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>refreshAll</code> - true if this instance is one of a collection of
objects being refreshed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the object needs a refresh, false otherwise</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Broker.html#refresh(java.lang.Object,org.apache.openjpa.kernel.OpCallbacks)"><code>Broker.refresh(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks)</code></a></dd>
</dl>
</li>
</ul>
<a id="setRemote(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemote</h4>
<pre class="methodSignature">void&nbsp;setRemote&#8203;(int&nbsp;field,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;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="simpleTagLabel">Since:</span></dt>
<dd>0.3.1</dd>
</dl>
</li>
</ul>
<a id="isDelayed(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDelayed</h4>
<pre class="methodSignature">boolean&nbsp;isDelayed&#8203;(int&nbsp;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="returnLabel">Returns:</span></dt>
<dd>true if the field is setup for delayed access</dd>
</dl>
</li>
</ul>
<a id="setDelayed(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelayed</h4>
<pre class="methodSignature">void&nbsp;setDelayed&#8203;(int&nbsp;field,
boolean&nbsp;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 id="loadDelayedField(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadDelayedField</h4>
<pre class="methodSignature">void&nbsp;loadDelayedField&#8203;(int&nbsp;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 id="fetchObjectField(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fetchObjectField</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;fetchObjectField&#8203;(int&nbsp;field)</pre>
<div class="block">Fetch an object field by index.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../enhance/FieldSupplier.html#fetchObjectField(int)">fetchObjectField</a></code>&nbsp;in interface&nbsp;<code><a href="../enhance/FieldSupplier.html" title="interface in org.apache.openjpa.enhance">FieldSupplier</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>