blob: 764a6c72c8ca875ac06fbf4a42b72a74590905d5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:26 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DetachState (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DetachState (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</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/DetachState.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/DetachManagerLite.html" title="class in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/kernel/DistinctResultList.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/DetachState.html" target="_top">Frames</a></li>
<li><a href="DetachState.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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>Method</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 DetachState" class="title">Interface DetachState</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>, <a href="../../../../org/apache/openjpa/slice/DistributedBroker.html" title="interface in org.apache.openjpa.slice">DistributedBroker</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>, <a href="../../../../org/apache/openjpa/kernel/DelegatingBroker.html" title="class in org.apache.openjpa.kernel">DelegatingBroker</a>, <a href="../../../../org/apache/openjpa/kernel/DetachManager.html" title="class in org.apache.openjpa.kernel">DetachManager</a>, <a href="../../../../org/apache/openjpa/conf/DetachOptions.html" title="class in org.apache.openjpa.conf">DetachOptions</a>, <a href="../../../../org/apache/openjpa/conf/DetachOptions.All.html" title="class in org.apache.openjpa.conf">DetachOptions.All</a>, <a href="../../../../org/apache/openjpa/conf/DetachOptions.FetchGroups.html" title="class in org.apache.openjpa.conf">DetachOptions.FetchGroups</a>, <a href="../../../../org/apache/openjpa/conf/DetachOptions.Loaded.html" title="class in org.apache.openjpa.conf">DetachOptions.Loaded</a>, <a href="../../../../org/apache/openjpa/slice/DistributedBrokerImpl.html" title="class in org.apache.openjpa.slice">DistributedBrokerImpl</a>, <a href="../../../../org/apache/openjpa/kernel/FinalizingBrokerImpl.html" title="class in org.apache.openjpa.kernel">FinalizingBrokerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">DetachState</span></pre>
<div class="block">Constants for which fields to include in the detach graph.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.4.0</dd>
<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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/DetachState.html#DETACH_ALL">DETACH_ALL</a></strong></code>
<div class="block">Mode to detach all fields.</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/DetachState.html#DETACH_FETCH_GROUPS">DETACH_FETCH_GROUPS</a></strong></code>
<div class="block">Mode to detach all fields in the current fetch groups.</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/DetachState.html#DETACH_FGS">DETACH_FGS</a></strong></code>
<div class="block"><strong>Deprecated.</strong>&nbsp;&nbsp;</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/DetachState.html#DETACH_LOADED">DETACH_LOADED</a></strong></code>
<div class="block">Mode to detach all currently-loaded fields.</div>
</td>
</tr>
</table>
</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="DETACH_FETCH_GROUPS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DETACH_FETCH_GROUPS</h4>
<pre>static final&nbsp;int DETACH_FETCH_GROUPS</pre>
<div class="block">Mode to detach all fields in the current fetch groups.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.9.8</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.DetachState.DETACH_FETCH_GROUPS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DETACH_FGS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DETACH_FGS</h4>
<pre>static final&nbsp;int DETACH_FGS</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i></i></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.DetachState.DETACH_FGS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DETACH_LOADED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DETACH_LOADED</h4>
<pre>static final&nbsp;int DETACH_LOADED</pre>
<div class="block">Mode to detach all currently-loaded fields.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.DetachState.DETACH_LOADED">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DETACH_ALL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DETACH_ALL</h4>
<pre>static final&nbsp;int DETACH_ALL</pre>
<div class="block">Mode to detach all fields.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.kernel.DetachState.DETACH_ALL">Constant Field Values</a></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/DetachState.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/DetachManagerLite.html" title="class in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/kernel/DistinctResultList.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/DetachState.html" target="_top">Frames</a></li>
<li><a href="DetachState.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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>Method</li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>