Google Git
Sign in
apache / openjpa-site / refs/heads/builds / . / 4.1.1 / apidocs / org / apache / openjpa / persistence / FetchPlan.html
blob: c5e9d21bb7eb8102e6feb82f9b7c6fa809ead4e1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>FetchPlan (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="FetchPlan (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":38,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":38,"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":38,"i49":6,"i50":6,"i51":6,"i52":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/FetchPlan.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.persistence</a></div>
<h2 title="Interface FetchPlan" class="title">Interface FetchPlan</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="jdbc/JDBCFetchPlan.html" title="interface in org.apache.openjpa.persistence.jdbc">JDBCFetchPlan</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="FetchPlanImpl.html" title="class in org.apache.openjpa.persistence">FetchPlanImpl</a></code>, <code><a href="jdbc/JDBCFetchPlanImpl.html" title="class in org.apache.openjpa.persistence.jdbc">JDBCFetchPlanImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">FetchPlan</span></pre>
<div class="block">The fetch plan allows you to dynamically alter eager fetching
configuration and other aspects of data loading.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4.1</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Abe White, Pinaki Poddar</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="#DEFAULT">DEFAULT</a></span></code></th>
<td class="colLast">
<div class="block">Constant to revert any setting to its default value.</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="#DEPTH_INFINITE">DEPTH_INFINITE</a></span></code></th>
<td class="colLast">
<div class="block">Infinite fetch depth.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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="#GROUP_ALL">GROUP_ALL</a></span></code></th>
<td class="colLast">
<div class="block">Fetch group representing all fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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="#GROUP_DEFAULT">GROUP_DEFAULT</a></span></code></th>
<td class="colLast">
<div class="block">The default fetch group.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFetchGroup(java.lang.String)">addFetchGroup</a></span>&#8203;(<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;group)</code></th>
<td class="colLast">
<div class="block">Adds <code>group</code> to the set of fetch group to
use when loading objects.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFetchGroups(java.lang.String...)">addFetchGroups</a></span>&#8203;(<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;groups)</code></th>
<td class="colLast">
<div class="block">Adds <code>groups</code> to the set of fetch group names to
use when loading objects.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFetchGroups(java.util.Collection)">addFetchGroups</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;groups)</code></th>
<td class="colLast">
<div class="block">Adds <code>groups</code> to the set of fetch group names to
use when loading objects.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addField(java.lang.Class,java.lang.String)">addField</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;cls,
<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;field)</code></th>
<td class="colLast">
<div class="block">Adds <code>field</code> to the set of field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addField(java.lang.String)">addField</a></span>&#8203;(<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;field)</code></th>
<td class="colLast">
<div class="block">Adds <code>field</code> to the set of fully-qualified field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFields(java.lang.Class,java.lang.String...)">addFields</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;cls,
<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;fields)</code></th>
<td class="colLast">
<div class="block">Adds <code>fields</code> to the set of field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFields(java.lang.Class,java.util.Collection)">addFields</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;cls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Adds <code>fields</code> to the set of field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFields(java.lang.String...)">addFields</a></span>&#8203;(<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;fields)</code></th>
<td class="colLast">
<div class="block">Adds <code>fields</code> to the set of fully-qualified field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFields(java.util.Collection)">addFields</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Adds <code>fields</code> to the set of fully-qualified field names to
use when loading objects.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearFetchGroups()">clearFetchGroups</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears the set of fetch group names to use wen loading
data.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearFields()">clearFields</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears the set of field names to use wen loading
data.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheRetrieveMode()">getCacheRetrieveMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the current retrieve mode for data cache.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheStoreMode()">getCacheStoreMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the current storage mode for data cache.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDelegate()">getDelegate</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">cast to <a href="FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><code>FetchPlanImpl</code></a> instead.</div>
</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtendedPathLookup()">getExtendedPathLookup</a></span>()</code></th>
<td class="colLast">
<div class="block">Affirms if extended path lookup feature is active.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchBatchSize()">getFetchBatchSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the fetch batch size for large result set support.</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/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchGroups()">getFetchGroups</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of the fetch groups that this component will use
when loading objects.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFields()">getFields</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the fully qualified names of the fields that this component
will use when loading objects.</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/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="#getHint(java.lang.String)">getHint</a></span>&#8203;(<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;key)</code></th>
<td class="colLast">
<div class="block">Get the hint value for the given key.</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/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHints()">getHints</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the hints and their values currently set on this receiver.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>jakarta.persistence.PessimisticLockScope</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockScope()">getLockScope</a></span>()</code></th>
<td class="colLast">
<div class="block">The lock scope to use for locking loaded objects.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockTimeout()">getLockTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of milliseconds to wait for an object lock, or -1 for no
limit.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxFetchDepth()">getMaxFetchDepth</a></span>()</code></th>
<td class="colLast">
<div class="block">The maximum fetch depth when loading an object.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryResultCache()">getQueryResultCache</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#getQueryResultCacheEnabled()"><code>getQueryResultCacheEnabled()</code></a> instead.</div>
</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryResultCacheEnabled()">getQueryResultCacheEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Return whether or not query caching is enabled.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryTimeout()">getQueryTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">The number of milliseconds to wait for a query, or -1 for no
limit.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>jakarta.persistence.LockModeType</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadLockMode()">getReadLockMode</a></span>()</code></th>
<td class="colLast">
<div class="block">The lock level to use for locking loaded objects.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>jakarta.persistence.LockModeType</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWriteLockMode()">getWriteLockMode</a></span>()</code></th>
<td class="colLast">
<div class="block">The lock level to use for locking dirtied objects.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasField(java.lang.Class,java.lang.String)">hasField</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;cls,
<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;field)</code></th>
<td class="colLast">
<div class="block">Return true if the given field has been added.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasField(java.lang.String)">hasField</a></span>&#8203;(<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;field)</code></th>
<td class="colLast">
<div class="block">Return true if the given field has been added.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFetchGroup(java.lang.String)">removeFetchGroup</a></span>&#8203;(<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;group)</code></th>
<td class="colLast">
<div class="block">Remove the given fetch group.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFetchGroups(java.lang.String...)">removeFetchGroups</a></span>&#8203;(<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;groups)</code></th>
<td class="colLast">
<div class="block">Removes <code>groups</code> from the set of fetch group names
to use when loading objects.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFetchGroups(java.util.Collection)">removeFetchGroups</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;groups)</code></th>
<td class="colLast">
<div class="block">Removes <code>groups</code> from the set of fetch group names
to use when loading objects.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeField(java.lang.Class,java.lang.String)">removeField</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;cls,
<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;field)</code></th>
<td class="colLast">
<div class="block">Remove the given field.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeField(java.lang.String)">removeField</a></span>&#8203;(<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;field)</code></th>
<td class="colLast">
<div class="block">Remove the given fully-qualified field.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFields(java.lang.Class,java.lang.String...)">removeFields</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;cls,
<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;fields)</code></th>
<td class="colLast">
<div class="block">Removes <code>fields</code> from the set of field names
to use when loading objects.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFields(java.lang.Class,java.util.Collection)">removeFields</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;cls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Removes <code>fields</code> from the set of field names
to use when loading objects.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFields(java.lang.String...)">removeFields</a></span>&#8203;(<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;fields)</code></th>
<td class="colLast">
<div class="block">Removes <code>fields</code> from the set of fully-qualified field names
to use when loading objects.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFields(java.util.Collection)">removeFields</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</code></th>
<td class="colLast">
<div class="block">Removes <code>fields</code> from the set of fully-qualified field names
to use when loading objects.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetFetchGroups()">resetFetchGroups</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets the set of fetch groups to the list in the global configuration.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</a></span>&#8203;(<a href="../kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a>&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">Sets the current retrieve mode for data cache.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</a></span>&#8203;(<a href="../kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a>&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">Sets the current storage mode for data cache.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtendedPathLookup(boolean)">setExtendedPathLookup</a></span>&#8203;(boolean&nbsp;flag)</code></th>
<td class="colLast">
<div class="block">Sets extended path lookup feature.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchBatchSize(int)">setFetchBatchSize</a></span>&#8203;(int&nbsp;fetchBatchSize)</code></th>
<td class="colLast">
<div class="block">Set the fetch batch size for large result set support.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHint(java.lang.String,java.lang.Object)">setHint</a></span>&#8203;(<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;key,
<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 hint for the given key to the given value.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockScope(jakarta.persistence.PessimisticLockScope)">setLockScope</a></span>&#8203;(jakarta.persistence.PessimisticLockScope&nbsp;scope)</code></th>
<td class="colLast">
<div class="block">The lock scope to use for locking loaded objects.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockTimeout(int)">setLockTimeout</a></span>&#8203;(int&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">The number of milliseconds to wait for an object lock, or -1 for no
limit.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxFetchDepth(int)">setMaxFetchDepth</a></span>&#8203;(int&nbsp;depth)</code></th>
<td class="colLast">
<div class="block">The maximum fetch depth when loading an object.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryResultCache(boolean)">setQueryResultCache</a></span>&#8203;(boolean&nbsp;cache)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#setQueryResultCacheEnabled(boolean)"><code>setQueryResultCacheEnabled(boolean)</code></a> instead.</div>
</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryResultCacheEnabled(boolean)">setQueryResultCacheEnabled</a></span>&#8203;(boolean&nbsp;cache)</code></th>
<td class="colLast">
<div class="block">Control whether or not query caching is enabled.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryTimeout(int)">setQueryTimeout</a></span>&#8203;(int&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">The number of milliseconds to wait for a query, or -1 for no
limit.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadLockMode(jakarta.persistence.LockModeType)">setReadLockMode</a></span>&#8203;(jakarta.persistence.LockModeType&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">The lock level to use for locking loaded objects.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWriteLockMode(jakarta.persistence.LockModeType)">setWriteLockMode</a></span>&#8203;(jakarta.persistence.LockModeType&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">The lock level to use for locking dirtied objects.</div>
</td>
</tr>
</table>
</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="GROUP_ALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GROUP_ALL</h4>
<pre>static final&nbsp;<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> GROUP_ALL</pre>
<div class="block">Fetch group representing all fields.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_ALL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="GROUP_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GROUP_DEFAULT</h4>
<pre>static final&nbsp;<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> GROUP_DEFAULT</pre>
<div class="block">The default fetch group.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEPTH_INFINITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEPTH_INFINITE</h4>
<pre>static final&nbsp;int DEPTH_INFINITE</pre>
<div class="block">Infinite fetch depth.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEPTH_INFINITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>static final&nbsp;int DEFAULT</pre>
<div class="block">Constant to revert any setting to its default value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEFAULT">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="getMaxFetchDepth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxFetchDepth</h4>
<pre class="methodSignature">int&nbsp;getMaxFetchDepth()</pre>
<div class="block">The maximum fetch depth when loading an object.</div>
</li>
</ul>
<a id="setMaxFetchDepth(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxFetchDepth</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setMaxFetchDepth&#8203;(int&nbsp;depth)</pre>
<div class="block">The maximum fetch depth when loading an object.</div>
</li>
</ul>
<a id="getFetchBatchSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchBatchSize</h4>
<pre class="methodSignature">int&nbsp;getFetchBatchSize()</pre>
<div class="block">Return the fetch batch size for large result set support.
Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note
that this property will be ignored under some data stores.</div>
</li>
</ul>
<a id="setFetchBatchSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchBatchSize</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setFetchBatchSize&#8203;(int&nbsp;fetchBatchSize)</pre>
<div class="block">Set the fetch batch size for large result set support.
Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note
that this property will be ignored under some data stores.</div>
</li>
</ul>
<a id="getQueryResultCacheEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResultCacheEnabled</h4>
<pre class="methodSignature">boolean&nbsp;getQueryResultCacheEnabled()</pre>
<div class="block">Return whether or not query caching is enabled. If this returns
<code>true</code> but the datacache plugin is not installed, caching
will not be enabled. If this
returns <code>false</code>, query caching will not be used
even if the datacache plugin is installed.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0.0</dd>
</dl>
</li>
</ul>
<a id="setQueryResultCacheEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryResultCacheEnabled</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setQueryResultCacheEnabled&#8203;(boolean&nbsp;cache)</pre>
<div class="block">Control whether or not query caching is enabled. This has no effect
if the datacache plugin is not installed, or if the query cache size
is set to zero.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0.0</dd>
</dl>
</li>
</ul>
<a id="getQueryResultCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResultCache</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
boolean&nbsp;getQueryResultCache()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#getQueryResultCacheEnabled()"><code>getQueryResultCacheEnabled()</code></a> instead.</div>
</div>
</li>
</ul>
<a id="setQueryResultCache(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryResultCache</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
<a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setQueryResultCache&#8203;(boolean&nbsp;cache)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#setQueryResultCacheEnabled(boolean)"><code>setQueryResultCacheEnabled(boolean)</code></a> instead.</div>
</div>
</li>
</ul>
<a id="getFetchGroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchGroups</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;&nbsp;getFetchGroups()</pre>
<div class="block">Returns the names of the fetch groups that this component will use
when loading objects. Defaults to the
<code>openjpa.FetchGroups</code> setting.</div>
</li>
</ul>
<a id="addFetchGroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFetchGroup</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFetchGroup&#8203;(<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;group)</pre>
<div class="block">Adds <code>group</code> to the set of fetch group to
use when loading objects.</div>
</li>
</ul>
<a id="addFetchGroups(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFetchGroups&#8203;(<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;groups)</pre>
<div class="block">Adds <code>groups</code> to the set of fetch group names to
use when loading objects.</div>
</li>
</ul>
<a id="addFetchGroups(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFetchGroups&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;groups)</pre>
<div class="block">Adds <code>groups</code> to the set of fetch group names to
use when loading objects.</div>
</li>
</ul>
<a id="removeFetchGroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFetchGroup</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFetchGroup&#8203;(<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;group)</pre>
<div class="block">Remove the given fetch group.</div>
</li>
</ul>
<a id="removeFetchGroups(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFetchGroups&#8203;(<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;groups)</pre>
<div class="block">Removes <code>groups</code> from the set of fetch group names
to use when loading objects.</div>
</li>
</ul>
<a id="removeFetchGroups(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFetchGroups&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;groups)</pre>
<div class="block">Removes <code>groups</code> from the set of fetch group names
to use when loading objects.</div>
</li>
</ul>
<a id="clearFetchGroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;clearFetchGroups()</pre>
<div class="block">Clears the set of fetch group names to use wen loading
data. After this operation is invoked, only those fields in
the default fetch group (and any requested field) will be
loaded when loading an object.</div>
</li>
</ul>
<a id="resetFetchGroups()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetFetchGroups</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;resetFetchGroups()</pre>
<div class="block">Resets the set of fetch groups to the list in the global configuration.</div>
</li>
</ul>
<a id="getFields()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFields</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<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>&gt;&nbsp;getFields()</pre>
<div class="block">Returns the fully qualified names of the fields that this component
will use when loading objects. Defaults to the empty set.</div>
</li>
</ul>
<a id="hasField(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasField</h4>
<pre class="methodSignature">boolean&nbsp;hasField&#8203;(<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;field)</pre>
<div class="block">Return true if the given field has been added.</div>
</li>
</ul>
<a id="hasField(java.lang.Class,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasField</h4>
<pre class="methodSignature">boolean&nbsp;hasField&#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;cls,
<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;field)</pre>
<div class="block">Return true if the given field has been added.</div>
</li>
</ul>
<a id="addField(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addField</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addField&#8203;(<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;field)</pre>
<div class="block">Adds <code>field</code> to the set of fully-qualified field names to
use when loading objects.</div>
</li>
</ul>
<a id="addField(java.lang.Class,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addField</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addField&#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;cls,
<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;field)</pre>
<div class="block">Adds <code>field</code> to the set of field names to
use when loading objects.</div>
</li>
</ul>
<a id="addFields(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFields&#8203;(<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;fields)</pre>
<div class="block">Adds <code>fields</code> to the set of fully-qualified field names to
use when loading objects.</div>
</li>
</ul>
<a id="addFields(java.lang.Class,java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFields&#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;cls,
<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;fields)</pre>
<div class="block">Adds <code>fields</code> to the set of field names to
use when loading objects.</div>
</li>
</ul>
<a id="addFields(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFields&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</pre>
<div class="block">Adds <code>fields</code> to the set of fully-qualified field names to
use when loading objects.</div>
</li>
</ul>
<a id="addFields(java.lang.Class,java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;addFields&#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;cls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</pre>
<div class="block">Adds <code>fields</code> to the set of field names to
use when loading objects.</div>
</li>
</ul>
<a id="removeField(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeField</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeField&#8203;(<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;field)</pre>
<div class="block">Remove the given fully-qualified field.</div>
</li>
</ul>
<a id="removeField(java.lang.Class,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeField</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeField&#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;cls,
<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;field)</pre>
<div class="block">Remove the given field.</div>
</li>
</ul>
<a id="removeFields(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFields&#8203;(<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;fields)</pre>
<div class="block">Removes <code>fields</code> from the set of fully-qualified field names
to use when loading objects.</div>
</li>
</ul>
<a id="removeFields(java.lang.Class,java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFields&#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;cls,
<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;fields)</pre>
<div class="block">Removes <code>fields</code> from the set of field names
to use when loading objects.</div>
</li>
</ul>
<a id="removeFields(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFields&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</pre>
<div class="block">Removes <code>fields</code> from the set of fully-qualified field names
to use when loading objects.</div>
</li>
</ul>
<a id="removeFields(java.lang.Class,java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;removeFields&#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;cls,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&nbsp;fields)</pre>
<div class="block">Removes <code>fields</code> from the set of field names
to use when loading objects.</div>
</li>
</ul>
<a id="clearFields()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearFields</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;clearFields()</pre>
<div class="block">Clears the set of field names to use wen loading
data. After this operation is invoked, only those fields in
the configured fetch groups will be loaded when loading an object.</div>
</li>
</ul>
<a id="getLockTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockTimeout</h4>
<pre class="methodSignature">int&nbsp;getLockTimeout()</pre>
<div class="block">The number of milliseconds to wait for an object lock, or -1 for no
limit.</div>
</li>
</ul>
<a id="setLockTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockTimeout</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setLockTimeout&#8203;(int&nbsp;timeout)</pre>
<div class="block">The number of milliseconds to wait for an object lock, or -1 for no
limit.</div>
</li>
</ul>
<a id="getLockScope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockScope</h4>
<pre class="methodSignature">jakarta.persistence.PessimisticLockScope&nbsp;getLockScope()</pre>
<div class="block">The lock scope to use for locking loaded objects.</div>
</li>
</ul>
<a id="setLockScope(jakarta.persistence.PessimisticLockScope)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockScope</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setLockScope&#8203;(jakarta.persistence.PessimisticLockScope&nbsp;scope)</pre>
<div class="block">The lock scope to use for locking loaded objects.</div>
</li>
</ul>
<a id="getQueryTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryTimeout</h4>
<pre class="methodSignature">int&nbsp;getQueryTimeout()</pre>
<div class="block">The number of milliseconds to wait for a query, or -1 for no
limit.</div>
</li>
</ul>
<a id="setQueryTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryTimeout</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setQueryTimeout&#8203;(int&nbsp;timeout)</pre>
<div class="block">The number of milliseconds to wait for a query, or -1 for no
limit.</div>
</li>
</ul>
<a id="getReadLockMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadLockMode</h4>
<pre class="methodSignature">jakarta.persistence.LockModeType&nbsp;getReadLockMode()</pre>
<div class="block">The lock level to use for locking loaded objects.</div>
</li>
</ul>
<a id="setReadLockMode(jakarta.persistence.LockModeType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadLockMode</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setReadLockMode&#8203;(jakarta.persistence.LockModeType&nbsp;mode)</pre>
<div class="block">The lock level to use for locking loaded objects.</div>
</li>
</ul>
<a id="getWriteLockMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteLockMode</h4>
<pre class="methodSignature">jakarta.persistence.LockModeType&nbsp;getWriteLockMode()</pre>
<div class="block">The lock level to use for locking dirtied objects.</div>
</li>
</ul>
<a id="setWriteLockMode(jakarta.persistence.LockModeType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWriteLockMode</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setWriteLockMode&#8203;(jakarta.persistence.LockModeType&nbsp;mode)</pre>
<div class="block">The lock level to use for locking dirtied objects.</div>
</li>
</ul>
<a id="getDelegate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelegate</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
<a href="../kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a>&nbsp;getDelegate()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">cast to <a href="FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><code>FetchPlanImpl</code></a> instead. This
method pierces the published-API boundary, as does the SPI cast.</div>
</div>
</li>
</ul>
<a id="getExtendedPathLookup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtendedPathLookup</h4>
<pre class="methodSignature">boolean&nbsp;getExtendedPathLookup()</pre>
<div class="block">Affirms if extended path lookup feature is active.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="setExtendedPathLookup(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExtendedPathLookup</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setExtendedPathLookup&#8203;(boolean&nbsp;flag)</pre>
<div class="block">Sets extended path lookup feature.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="getCacheStoreMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheStoreMode</h4>
<pre class="methodSignature"><a href="../kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a>&nbsp;getCacheStoreMode()</pre>
<div class="block">Gets the current storage mode for data cache.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheStoreMode</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setCacheStoreMode&#8203;(<a href="../kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</a>&nbsp;mode)</pre>
<div class="block">Sets the current storage mode for data cache.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="getCacheRetrieveMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheRetrieveMode</h4>
<pre class="methodSignature"><a href="../kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a>&nbsp;getCacheRetrieveMode()</pre>
<div class="block">Gets the current retrieve mode for data cache.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheRetrieveMode</h4>
<pre class="methodSignature"><a href="FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;setCacheRetrieveMode&#8203;(<a href="../kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</a>&nbsp;mode)</pre>
<div class="block">Sets the current retrieve mode for data cache.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="setHint(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHint</h4>
<pre class="methodSignature">void&nbsp;setHint&#8203;(<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;key,
<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 hint for the given key to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the value of the hint.</dd>
<dd><code>name</code> - the name of the hint.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
</dl>
</li>
</ul>
<a id="getHints()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHints</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<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>,&#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>&gt;&nbsp;getHints()</pre>
<div class="block">Get the hints and their values currently set on this receiver.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>empty map if no hint has been set.</dd>
</dl>
</li>
</ul>
<a id="getHint(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHint</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;getHint&#8203;(<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;key)</pre>
<div class="block">Get the hint value for the given key.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if the key has not been set.</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/FetchPlan.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>