blob: 46e3760617d04185ee279feb200b7ccc187f6581 [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 (1.8.0_252) on Fri Jul 16 09:39:08 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ReadQuery (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ReadQuery (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/queries/ReadObjectQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/queries/ReportQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/queries/ReadQuery.html" target="_top">Frames</a></li>
<li><a href="ReadQuery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.classes.inherited.from.class.org.eclipse.persistence.queries.DatabaseQuery">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.queries</div>
<h2 title="Class ReadQuery" class="title">Class ReadQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">org.eclipse.persistence.queries.DatabaseQuery</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.queries.ReadQuery</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/eclipse/persistence/queries/DataReadQuery.html" title="class in org.eclipse.persistence.queries">DataReadQuery</a>, <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ReadQuery</span>
extends <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></pre>
<div class="block"><p><b>Purpose</b>:
Abstract class for all read queries.
<p><b>Responsibilities</b>:
<ul>
<li> Caches result of query if flag is set.
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.eclipse.persistence.queries.ReadQuery">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Yvon Lavoie</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>TOPLink/Java 1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.persistence.queries.DatabaseQuery">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&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>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#fetchSize">fetchSize</a></span></code>
<div class="block">Used to set statement fetch size</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#firstResult">firstResult</a></span></code>
<div class="block">Used to start query results at a specific result</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#maxResults">maxResults</a></span></code>
<div class="block">Stores the JPA maxResult settings for a NamedQuery</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#maxRows">maxRows</a></span></code>
<div class="block">Used for retrieve limited rows through the query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#queryId">queryId</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#queryResultCachingPolicy">queryResultCachingPolicy</a></span></code>
<div class="block">Used to specify how query results are cached</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#temporaryCachedQueryResults">temporaryCachedQueryResults</a></span></code>
<div class="block">Optimization: temporarily stores cached query results while they are being built in a cloned query</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.queries.DatabaseQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#accessors">accessors</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#allowNativeSQLQuery">allowNativeSQLQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentFields">argumentFields</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentParameterTypes">argumentParameterTypes</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#arguments">arguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentTypeNames">argumentTypeNames</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentTypes">argumentTypes</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentValues">argumentValues</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#BATCH_FETCH_PROPERTY">BATCH_FETCH_PROPERTY</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeAggregateDelete">CascadeAggregateDelete</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeAllParts">CascadeAllParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeByMapping">CascadeByMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeDependentParts">CascadeDependentParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadePolicy">cascadePolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadePrivateParts">CascadePrivateParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#descriptor">descriptor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#descriptors">descriptors</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#doNotRedirect">doNotRedirect</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executionSession">executionSession</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#flushOnExecute">flushOnExecute</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hintString">hintString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomQueryUsed">isCustomQueryUsed</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExecutionClone">isExecutionClone</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isNativeConnectionRequired">isNativeConnectionRequired</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isPrepared">isPrepared</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefined">isUserDefined</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefinedSQLCall">isUserDefinedSQLCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#monitorName">monitorName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#name">name</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#NoCascading">NoCascading</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#nullableArguments">nullableArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#parameterDelimiter">parameterDelimiter</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#partitioningPolicy">partitioningPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#properties">properties</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryMechanism">queryMechanism</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryTimeout">queryTimeout</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryTimeoutUnit">queryTimeoutUnit</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#redirector">redirector</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#session">session</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#sessionName">sessionName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldBindAllParameters">shouldBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCacheStatement">shouldCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCloneCall">shouldCloneCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldMaintainCache">shouldMaintainCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare">shouldPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldRetrieveBypassCache">shouldRetrieveBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldStoreBypassCache">shouldStoreBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldUseWrapperPolicy">shouldUseWrapperPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldValidateUpdateCallCacheUse">shouldValidateUpdateCallCacheUse</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#sourceMapping">sourceMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#translationRow">translationRow</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#ReadQuery--">ReadQuery</a></span>()</code>
<div class="block">PUBLIC:
Initialize the state of the query</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#buildObject-org.eclipse.persistence.internal.sessions.AbstractRecord-">buildObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</code>
<div class="block">INTERNAL:
By default return the row.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#cacheQueryResults--">cacheQueryResults</a></span>()</code>
<div class="block">ADVANCED:</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#cacheResult-java.lang.Object-">cacheResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#clearQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-">clearQueryResults</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">PUBLIC:
Clears the current cached results, the next execution with
read from the database.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#clonedQueryExecutionComplete-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">clonedQueryExecutionComplete</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL
Used to give the subclasses opportunity to copy aspects of the cloned query
to the original query.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#copyFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">copyFromQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query)</code>
<div class="block">INTERNAL:
Copy all setting from the query.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#doNotCacheQueryResults--">doNotCacheQueryResults</a></span>()</code>
<div class="block">ADVANCED:</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getFetchSize--">getFetchSize</a></span>()</code>
<div class="block">PUBLIC:
Return the fetchSize setting that this query will set on the JDBC Statement
NB - a value of zero means that no call to statement.setFetchSize() will be made.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getFirstResult--">getFirstResult</a></span>()</code>
<div class="block">PUBLIC:
Return the value that will be set for the firstResult in the returned result set</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getInternalMax--">getInternalMax</a></span>()</code>
<div class="block">INTERNAL:
returns the JPA max results that may have been set on a NamedQuery</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getMaxRows--">getMaxRows</a></span>()</code>
<div class="block">PUBLIC:
Return the limit for the maximum number of rows that any ResultSet can contain to the given number.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getQueryId--">getQueryId</a></span>()</code>
<div class="block">INTERNAL:
This method is used to get the time in millis that this query is being executed at.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-">getQueryResults</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-boolean-">getQueryResults</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
boolean&nbsp;checkExpiry)</code>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">getQueryResults</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;checkExpiry)</code>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getQueryResultsCachePolicy--">getQueryResultsCachePolicy</a></span>()</code>
<div class="block">PUBLIC:
Return the QueryResultsCachePolicy for this query.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#getTemporaryCachedQueryResults--">getTemporaryCachedQueryResults</a></span>()</code>
<div class="block">INTERNAL:
Get results from the remporary cache.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#isDefaultPropertiesQuery--">isDefaultPropertiesQuery</a></span>()</code>
<div class="block">INTERNAL:
Return true if the query uses default properties.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#isReadQuery--">isReadQuery</a></span>()</code>
<div class="block">PUBLIC:
Return if this is a read query.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#prepare--">prepare</a></span>()</code>
<div class="block">INTERNAL:
This is different from 'prepareForExecution' in that this is called on the original query,
and the other is called on the copy of the query.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#prepareForExecution--">prepareForExecution</a></span>()</code>
<div class="block">INTERNAL:
Prepare the receiver for execution in a session.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#remoteExecute-org.eclipse.persistence.internal.sessions.AbstractSession-">remoteExecute</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Return if this is a read query.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setFetchSize-int-">setFetchSize</a></span>(int&nbsp;fetchSize)</code>
<div class="block">PUBLIC:
Set the fetchSize setting that this query will set on the JDBC Statement
NB - a value of zero means that no call to statement.setFetchSize() will be made.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setFirstResult-int-">setFirstResult</a></span>(int&nbsp;firstResult)</code>
<div class="block">PUBLIC:
Used to set the first result in any result set that is returned for this query.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setInternalMax-int-">setInternalMax</a></span>(int&nbsp;max)</code>
<div class="block">INTERNAL:
sets the JPA max results that may have been set on a NamedQuery</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setMaxRows-int-">setMaxRows</a></span>(int&nbsp;maxRows)</code>
<div class="block">PUBLIC:
Used to set the limit for the maximum number of rows that any ResultSet can contain to the given number.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryId-long-">setQueryId</a></span>(long&nbsp;id)</code>
<div class="block">INTERNAL:
This method is used to set the current system time in millis that this query is being executed at.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResults-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">setQueryResults</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;resultFromQuery,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Set the cached results of the query.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-">setQueryResultsCachePolicy</a></span>(<a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a>&nbsp;policy)</code>
<div class="block">Set the QueryResultsCachePolicy.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setTemporaryCachedQueryResults-java.lang.Object-">setTemporaryCachedQueryResults</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;queryResults)</code>
<div class="block">INTERNAL:
Put results in the temporary cache.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#shouldCacheQueryResults--">shouldCacheQueryResults</a></span>()</code>
<div class="block">PUBLIC:
Return if the query should cache the results of the next execution or not.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.queries.DatabaseQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-boolean-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-boolean-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.String-">addArgument</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgumentByTypeName-java.lang.String-java.lang.String-">addArgumentByTypeName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgumentValue-java.lang.Object-">addArgumentValue</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgumentValues-java.util.List-">addArgumentValues</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addCall-org.eclipse.persistence.queries.Call-">addCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addStatement-org.eclipse.persistence.internal.expressions.SQLStatement-">addStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#bindAllParameters--">bindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#buildArgumentFields--">buildArgumentFields</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#buildSelectionCriteria-org.eclipse.persistence.internal.sessions.AbstractSession-">buildSelectionCriteria</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cacheStatement--">cacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeAllParts--">cascadeAllParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeByMapping--">cascadeByMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeOnlyDependentParts--">cascadeOnlyDependentParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadePrivateParts--">cascadePrivateParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">checkDescriptor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkEarlyReturn-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkEarlyReturn</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkForCustomQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkForCustomQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-boolean-">checkPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#clone--">clone</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontBindAllParameters--">dontBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontCacheStatement--">dontCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontCascadeParts--">dontCascadeParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontMaintainCache--">dontMaintainCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#execute-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">execute</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executeDatabaseQuery--">executeDatabaseQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executeInUnitOfWork-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractRecord-">executeInUnitOfWork</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#extractRemoteResult-org.eclipse.persistence.internal.sessions.remote.Transporter-">extractRemoteResult</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getAccessor--">getAccessor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getAccessors--">getAccessors</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentParameterTypes--">getArgumentParameterTypes</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArguments--">getArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentTypeNames--">getArgumentTypeNames</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentTypes--">getArgumentTypes</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentValues--">getArgumentValues</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getBatchObjects--">getBatchObjects</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getCall--">getCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getCascadePolicy--">getCascadePolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDatasourceCall--">getDatasourceCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDatasourceCalls--">getDatasourceCalls</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDefaultRedirector--">getDefaultRedirector</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDescriptor--">getDescriptor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDescriptors--">getDescriptors</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDomainClassNounName-java.lang.String-">getDomainClassNounName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDoNotRedirect--">getDoNotRedirect</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getEJBQLString--">getEJBQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getExecutionSession--">getExecutionSession</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getFlushOnExecute--">getFlushOnExecute</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getHintString--">getHintString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getJPQLString--">getJPQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getMonitorName--">getMonitorName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getName--">getName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getNullableArguments--">getNullableArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getParameterDelimiter--">getParameterDelimiter</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getParameterDelimiterChar--">getParameterDelimiterChar</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getPartitioningPolicy--">getPartitioningPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getProperties--">getProperties</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getProperty-java.lang.Object-">getProperty</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryMechanism--">getQueryMechanism</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryNounName-java.lang.String-">getQueryNounName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryTimeout--">getQueryTimeout</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryTimeoutUnit--">getQueryTimeoutUnit</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getRedirector--">getRedirector</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getRedirectorForQuery--">getRedirectorForQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getReferenceClass--">getReferenceClass</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getReferenceClassName--">getReferenceClassName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSelectionCriteria--">getSelectionCriteria</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSensorName-java.lang.String-java.lang.String-">getSensorName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSession--">getSession</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSessionName--">getSessionName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getShouldBindAllParameters--">getShouldBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSourceMapping--">getSourceMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLStatement--">getSQLStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLString--">getSQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLStrings--">getSQLStrings</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslatedSQLString-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">getTranslatedSQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslatedSQLStrings-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">getTranslatedSQLStrings</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslationRow--">getTranslationRow</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasAccessor--">hasAccessor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasArguments--">hasArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasNullableArguments--">hasNullableArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasProperties--">hasProperties</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasQueryMechanism--">hasQueryMechanism</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasSessionName--">hasSessionName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#ignoreBindAllParameters--">ignoreBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#ignoreCacheStatement--">ignoreCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCallQuery--">isCallQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCascadeOfAggregateDelete--">isCascadeOfAggregateDelete</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomQueryUsed--">isCustomQueryUsed</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomSelectionQuery--">isCustomSelectionQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDataModifyQuery--">isDataModifyQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDataReadQuery--">isDataReadQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDeleteAllQuery--">isDeleteAllQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDeleteObjectQuery--">isDeleteObjectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDirectReadQuery--">isDirectReadQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExecutionClone--">isExecutionClone</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExpressionQuery--">isExpressionQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isInsertObjectQuery--">isInsertObjectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isJPQLCallQuery--">isJPQLCallQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isModifyAllQuery--">isModifyAllQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isModifyQuery--">isModifyQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isNativeConnectionRequired--">isNativeConnectionRequired</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectBuildingQuery--">isObjectBuildingQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectLevelModifyQuery--">isObjectLevelModifyQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectLevelReadQuery--">isObjectLevelReadQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isPrepared--">isPrepared</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadAllQuery--">isReadAllQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadObjectQuery--">isReadObjectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReportQuery--">isReportQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isResultSetMappingQuery--">isResultSetMappingQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isSQLCallQuery--">isSQLCallQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUpdateAllQuery--">isUpdateAllQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUpdateObjectQuery--">isUpdateObjectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefined--">isUserDefined</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefinedSQLCall--">isUserDefinedSQLCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isValueReadQuery--">isValueReadQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isWriteObjectQuery--">isWriteObjectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#maintainCache--">maintainCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">prepareCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCustomQuery-org.eclipse.persistence.queries.DatabaseQuery-">prepareCustomQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareForRemoteExecution--">prepareForRemoteExecution</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">prepareFromQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareInternal-org.eclipse.persistence.internal.sessions.AbstractSession-">prepareInternal</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#redirectQuery-org.eclipse.persistence.queries.QueryRedirector-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">redirectQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#remoteExecute--">remoteExecute</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#removeProperty-java.lang.Object-">removeProperty</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">replaceValueHoldersIn</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#resetMonitorName--">resetMonitorName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#retrieveBypassCache--">retrieveBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#rowFromArguments-java.util.List-org.eclipse.persistence.internal.sessions.AbstractSession-">rowFromArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAccessor-org.eclipse.persistence.internal.databaseaccess.Accessor-">setAccessor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAccessors-java.util.Collection-">setAccessors</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAllowNativeSQLQuery-java.lang.Boolean-">setAllowNativeSQLQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArguments-java.util.List-">setArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentTypeNames-java.util.List-">setArgumentTypeNames</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentTypes-java.util.List-">setArgumentTypes</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentValues-java.util.List-">setArgumentValues</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setBatchObjects-java.util.Map-">setBatchObjects</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setCall-org.eclipse.persistence.queries.Call-">setCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setCascadePolicy-int-">setCascadePolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDatasourceCall-org.eclipse.persistence.queries.Call-">setDatasourceCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDoNotRedirect-boolean-">setDoNotRedirect</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setEJBQLString-java.lang.String-">setEJBQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setExecutionSession</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setFlushOnExecute-java.lang.Boolean-">setFlushOnExecute</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setHintString-java.lang.String-">setHintString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsCustomQueryUsed-boolean-">setIsCustomQueryUsed</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsExecutionClone-boolean-">setIsExecutionClone</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsNativeConnectionRequired-boolean-">setIsNativeConnectionRequired</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsPrepared-boolean-">setIsPrepared</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsUserDefined-boolean-">setIsUserDefined</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsUserDefinedSQLCall-boolean-">setIsUserDefinedSQLCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setJPQLString-java.lang.String-">setJPQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setNullableArguments-java.util.List-">setNullableArguments</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setParameterDelimiter-java.lang.String-">setParameterDelimiter</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setPartitioningPolicy-org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy-">setPartitioningPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setProperties-java.util.Map-">setProperties</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setProperty-java.lang.Object-java.lang.Object-">setProperty</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryMechanism-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-">setQueryMechanism</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeout-int-">setQueryTimeout</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeoutUnit-java.util.concurrent.TimeUnit-">setQueryTimeoutUnit</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setRedirector-org.eclipse.persistence.queries.QueryRedirector-">setRedirector</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSelectionCriteria-org.eclipse.persistence.expressions.Expression-">setSelectionCriteria</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSessionName-java.lang.String-">setSessionName</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-boolean-">setShouldBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-java.lang.Boolean-">setShouldBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldCacheStatement-boolean-">setShouldCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldMaintainCache-boolean-">setShouldMaintainCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldPrepare-boolean-">setShouldPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldRetrieveBypassCache-boolean-">setShouldRetrieveBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldStoreBypassCache-boolean-">setShouldStoreBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldUseWrapperPolicy-boolean-">setShouldUseWrapperPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldValidateUpdateCallCacheUse-boolean-">setShouldValidateUpdateCallCacheUse</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSourceMapping-org.eclipse.persistence.mappings.DatabaseMapping-">setSourceMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSQLStatement-org.eclipse.persistence.internal.expressions.SQLStatement-">setSQLStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSQLString-java.lang.String-">setSQLString</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setTranslationRow</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldAllowNativeSQLQuery-boolean-">shouldAllowNativeSQLQuery</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldBindAllParameters--">shouldBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCacheStatement--">shouldCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeAllParts--">shouldCascadeAllParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeByMapping--">shouldCascadeByMapping</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeOnlyDependentParts--">shouldCascadeOnlyDependentParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeParts--">shouldCascadeParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadePrivateParts--">shouldCascadePrivateParts</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCloneCall--">shouldCloneCall</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldIgnoreBindAllParameters--">shouldIgnoreBindAllParameters</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldIgnoreCacheStatement--">shouldIgnoreCacheStatement</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldMaintainCache--">shouldMaintainCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare--">shouldPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">shouldPrepare</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldRetrieveBypassCache--">shouldRetrieveBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldStoreBypassCache--">shouldStoreBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldUseWrapperPolicy--">shouldUseWrapperPolicy</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldValidateUpdateCallCacheUse--">shouldValidateUpdateCallCacheUse</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#storeBypassCache--">storeBypassCache</a>, <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="maxRows">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxRows</h4>
<pre>protected&nbsp;int maxRows</pre>
<div class="block">Used for retrieve limited rows through the query.</div>
</li>
</ul>
<a name="firstResult">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firstResult</h4>
<pre>protected&nbsp;int firstResult</pre>
<div class="block">Used to start query results at a specific result</div>
</li>
</ul>
<a name="queryId">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryId</h4>
<pre>protected&nbsp;long queryId</pre>
</li>
</ul>
<a name="fetchSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchSize</h4>
<pre>protected&nbsp;int fetchSize</pre>
<div class="block">Used to set statement fetch size</div>
</li>
</ul>
<a name="queryResultCachingPolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryResultCachingPolicy</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a> queryResultCachingPolicy</pre>
<div class="block">Used to specify how query results are cached</div>
</li>
</ul>
<a name="temporaryCachedQueryResults">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>temporaryCachedQueryResults</h4>
<pre>protected transient&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> temporaryCachedQueryResults</pre>
<div class="block">Optimization: temporarily stores cached query results while they are being built in a cloned query</div>
</li>
</ul>
<a name="maxResults">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maxResults</h4>
<pre>protected&nbsp;int maxResults</pre>
<div class="block">Stores the JPA maxResult settings for a NamedQuery</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ReadQuery--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReadQuery</h4>
<pre>public&nbsp;ReadQuery()</pre>
<div class="block">PUBLIC:
Initialize the state of the query</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="buildObject-org.eclipse.persistence.internal.sessions.AbstractRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildObject</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;buildObject(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row)</pre>
<div class="block">INTERNAL:
By default return the row.
Used by cursored stream.</div>
</li>
</ul>
<a name="cacheQueryResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheQueryResults</h4>
<pre>public&nbsp;void&nbsp;cacheQueryResults()</pre>
<div class="block">ADVANCED:
<P>This method will instruct the query to cache the results returned by its
next execution. All subsequent executions of this query will return this
cached result set even if new query parameters are specified. This method
provides a performance enhancement for queries known to always return the
same result set. Oracle recommends that you use this method only for such
queries.</P>
<P>To disable this behavior, call <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#doNotCacheQueryResults--"><code>doNotCacheQueryResults()</code></a> or
<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-"><code>setQueryResultsCachePolicy(org.eclipse.persistence.queries.QueryResultsCachePolicy)</code></a> passing in null.</P></div>
</li>
</ul>
<a name="cacheResult-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheResult</h4>
<pre>public abstract&nbsp;void&nbsp;cacheResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;object)</pre>
<div class="block">INTERNAL:
<P> This method is called by the object builder when building an original.
It will cause the original to be cached in the query results if the query
is set to do so.</div>
</li>
</ul>
<a name="clonedQueryExecutionComplete-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clonedQueryExecutionComplete</h4>
<pre>protected&nbsp;void&nbsp;clonedQueryExecutionComplete(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL
Used to give the subclasses opportunity to copy aspects of the cloned query
to the original query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#clonedQueryExecutionComplete-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">clonedQueryExecutionComplete</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="clearQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearQueryResults</h4>
<pre>public&nbsp;void&nbsp;clearQueryResults(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">PUBLIC:
Clears the current cached results, the next execution with
read from the database.</div>
</li>
</ul>
<a name="doNotCacheQueryResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doNotCacheQueryResults</h4>
<pre>public&nbsp;void&nbsp;doNotCacheQueryResults()</pre>
<div class="block">ADVANCED:
<P>This method will instruct the query not to cache results. All subsequent
executions return result sets according to the current configuration of
query parameters. After calling this method, any previously cached result
set will be discarded the next time the query is executed.</P>
<P>To enable this behavior, call <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#cacheQueryResults--"><code>cacheQueryResults()</code></a> or
<a href="../../../../org/eclipse/persistence/queries/ReadQuery.html#setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-"><code>setQueryResultsCachePolicy(org.eclipse.persistence.queries.QueryResultsCachePolicy)</code></a> passing in a valid QueryResultsCachePolicy.</P>
Note: If this method is called on a query that initially cached query results,
clearQueryResults(Session) should also be called. Otherwise, the results of
this query will remain in the cache and cause extra memory use</div>
</li>
</ul>
<a name="getQueryResultsCachePolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResultsCachePolicy</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a>&nbsp;getQueryResultsCachePolicy()</pre>
<div class="block">PUBLIC:
Return the QueryResultsCachePolicy for this query.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries"><code>QueryResultsCachePolicy</code></a></dd>
</dl>
</li>
</ul>
<a name="getFirstResult--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstResult</h4>
<pre>public&nbsp;int&nbsp;getFirstResult()</pre>
<div class="block">PUBLIC:
Return the value that will be set for the firstResult in the returned result set</div>
</li>
</ul>
<a name="getQueryId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryId</h4>
<pre>public&nbsp;long&nbsp;getQueryId()</pre>
<div class="block">INTERNAL:
This method is used to get the time in millis that this query is being executed at.
it is set just prior to executing the SQL and will be used to determine which objects should be refreshed.
CR #4365
CR #2698903 ... instead of using millis we will now use id's instead. Method
renamed appropriately.</div>
</li>
</ul>
<a name="getInternalMax--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInternalMax</h4>
<pre>public&nbsp;int&nbsp;getInternalMax()</pre>
<div class="block">INTERNAL:
returns the JPA max results that may have been set on a NamedQuery</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maxResults</dd>
</dl>
</li>
</ul>
<a name="getMaxRows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxRows</h4>
<pre>public&nbsp;int&nbsp;getMaxRows()</pre>
<div class="block">PUBLIC:
Return the limit for the maximum number of rows that any ResultSet can contain to the given number.</div>
</li>
</ul>
<a name="getFetchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchSize</h4>
<pre>public&nbsp;int&nbsp;getFetchSize()</pre>
<div class="block">PUBLIC:
Return the fetchSize setting that this query will set on the JDBC Statement
NB - a value of zero means that no call to statement.setFetchSize() will be made.</div>
</li>
</ul>
<a name="getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResults</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getQueryResults(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.
Return the results of the query.
If the query has never been executed, or does not cache results,
the results will be null.</div>
</li>
</ul>
<a name="getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResults</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getQueryResults(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
boolean&nbsp;checkExpiry)</pre>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.
Return the results of the query.
If the query has never been executed, or does not cache results,
the results will be null.</div>
</li>
</ul>
<a name="getQueryResults-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryResults</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getQueryResults(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
boolean&nbsp;checkExpiry)</pre>
<div class="block">INTERNAL:
To any user of this object with some knowledge of what the query's results may contain.
Return the results of the query.
If the query has never been executed, or does not cache results,
the results will be null.</div>
</li>
</ul>
<a name="getTemporaryCachedQueryResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemporaryCachedQueryResults</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getTemporaryCachedQueryResults()</pre>
<div class="block">INTERNAL:
Get results from the remporary cache.
Used when caching query results on a clone so they can be copied to the original
query</div>
</li>
</ul>
<a name="isDefaultPropertiesQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefaultPropertiesQuery</h4>
<pre>public&nbsp;boolean&nbsp;isDefaultPropertiesQuery()</pre>
<div class="block">INTERNAL:
Return true if the query uses default properties.
This is used to determine if this query is cacheable.
i.e. does not use any properties that may conflict with another query
with the same EJBQL or selection criteria.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDefaultPropertiesQuery--">isDefaultPropertiesQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="isReadQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadQuery</h4>
<pre>public&nbsp;boolean&nbsp;isReadQuery()</pre>
<div class="block">PUBLIC:
Return if this is a read query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadQuery--">isReadQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="copyFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyFromQuery</h4>
<pre>public&nbsp;void&nbsp;copyFromQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a>&nbsp;query)</pre>
<div class="block">INTERNAL:
Copy all setting from the query.
This is used to morph queries from one type to the other.
By default this calls prepareFromQuery, but additional properties may be required
to be copied as prepareFromQuery only copies properties that affect the SQL.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#copyFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">copyFromQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="prepare--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>protected&nbsp;void&nbsp;prepare()
throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
<div class="block">INTERNAL:
This is different from 'prepareForExecution' in that this is called on the original query,
and the other is called on the copy of the query.
This query is copied for concurrency so this prepare can only setup things that
will apply to any future execution of this query.
Clear the query cache when a query is prepared.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepare--">prepare</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
</dl>
</li>
</ul>
<a name="prepareForExecution--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareForExecution</h4>
<pre>public&nbsp;void&nbsp;prepareForExecution()
throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre>
<div class="block">INTERNAL:
Prepare the receiver for execution in a session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareForExecution--">prepareForExecution</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd>
</dl>
</li>
</ul>
<a name="remoteExecute-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remoteExecute</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;remoteExecute(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Return if this is a read query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#remoteExecute-org.eclipse.persistence.internal.sessions.AbstractSession-">remoteExecute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd>
</dl>
</li>
</ul>
<a name="setQueryResultsCachePolicy-org.eclipse.persistence.queries.QueryResultsCachePolicy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryResultsCachePolicy</h4>
<pre>public&nbsp;void&nbsp;setQueryResultsCachePolicy(<a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries">QueryResultsCachePolicy</a>&nbsp;policy)</pre>
<div class="block">Set the QueryResultsCachePolicy.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/queries/QueryResultsCachePolicy.html" title="class in org.eclipse.persistence.queries"><code>QueryResultsCachePolicy</code></a></dd>
</dl>
</li>
</ul>
<a name="setFirstResult-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFirstResult</h4>
<pre>public&nbsp;void&nbsp;setFirstResult(int&nbsp;firstResult)</pre>
<div class="block">PUBLIC:
Used to set the first result in any result set that is returned for this query.
On supported database platforms this will cause the query to issue specific SQL
that avoids selecting the firstResult number of rows.
Otherwise by it will use the JDBC absolute to skip the firstResult number of rows.</div>
</li>
</ul>
<a name="setQueryId-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryId</h4>
<pre>public&nbsp;void&nbsp;setQueryId(long&nbsp;id)</pre>
<div class="block">INTERNAL:
This method is used to set the current system time in millis that this query is being executed at.
it is set just prior to executing the SQL and will be used to determine which objects should be refreshed.
CR #4365
CR #2698903 ... instead of using millis we will now use id's instead. Method
renamed appropriately.</div>
</li>
</ul>
<a name="setInternalMax-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInternalMax</h4>
<pre>public&nbsp;void&nbsp;setInternalMax(int&nbsp;max)</pre>
<div class="block">INTERNAL:
sets the JPA max results that may have been set on a NamedQuery</div>
</li>
</ul>
<a name="setMaxRows-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxRows</h4>
<pre>public&nbsp;void&nbsp;setMaxRows(int&nbsp;maxRows)</pre>
<div class="block">PUBLIC:
Used to set the limit for the maximum number of rows that any ResultSet can contain to the given number.
This method should only be set once per query. To change the max rows use another query.
This method limits the number of candidate results returned to TopLink that can be used to build objects</div>
</li>
</ul>
<a name="setFetchSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchSize</h4>
<pre>public&nbsp;void&nbsp;setFetchSize(int&nbsp;fetchSize)</pre>
<div class="block">PUBLIC:
Set the fetchSize setting that this query will set on the JDBC Statement
NB - a value of zero means that no call to statement.setFetchSize() will be made.</div>
</li>
</ul>
<a name="setQueryResults-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryResults</h4>
<pre>protected&nbsp;void&nbsp;setQueryResults(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;resultFromQuery,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;row,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Set the cached results of the query.
This will only be set if the query caches results.</div>
</li>
</ul>
<a name="shouldCacheQueryResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCacheQueryResults</h4>
<pre>public&nbsp;boolean&nbsp;shouldCacheQueryResults()</pre>
<div class="block">PUBLIC:
Return if the query should cache the results of the next execution or not.</div>
</li>
</ul>
<a name="setTemporaryCachedQueryResults-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTemporaryCachedQueryResults</h4>
<pre>public&nbsp;void&nbsp;setTemporaryCachedQueryResults(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;queryResults)</pre>
<div class="block">INTERNAL:
Put results in the temporary cache.
Used when caching query results on a clone so they can be copied to the original
query</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/queries/ReadObjectQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/queries/ReportQuery.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/queries/ReadQuery.html" target="_top">Frames</a></li>
<li><a href="ReadQuery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.eclipse.persistence.queries.DatabaseQuery">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>