blob: 7982195406dddc71d71316ee6656d6116251bae7 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Query (JDO API 3.2.1)</title>
<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="Query (JDO API 3.2.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="class-use/Query.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/Transaction.html" title="interface in javax.jdo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/jdo/Query.html" target="_top">Frames</a></li>
<li><a href="Query.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>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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.jdo</div>
<h2 title="Interface Query" class="title">Interface Query&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <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></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Query&lt;T&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <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></pre>
<div class="block">The <code>Query</code> interface allows applications to obtain persistent
instances, values, and aggregate data from the data store.
The <a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo"><code>PersistenceManager</code></a> is the factory for <code>Query</code>
instances. There may be many <code>Query</code> instances associated with a
<code>PersistenceManager</code>. Multiple queries might be executed
simultaneously by different threads, but the implementation might choose to
execute them serially. In either case, the implementation must be thread-safe.
<P>There are three required elements in a <code>Query</code>: the class of
the results, the candidate collection of instances, and the filter.
<P>There are optional elements: parameter declarations, variable
declarations, import statements, ordering and grouping specifications,
result and result class, the range of results,
and flags indicating whether the query result
is unique and whether the query can be modified.
<P>The query namespace is modeled after methods in Java:
<ul>
<li><code>setClass</code> corresponds to the class definition
<li><code>declareParameters</code> corresponds to formal parameters of a method
<li><code>declareVariables</code> corresponds to local variables of a method
<li><code>setFilter</code> and <code>setOrdering</code> correspond to the method body
</ul>
<P>There are two namespaces in queries. Type names have their own namespace
that is separate from the namespace for fields, variables and parameters.
<P>The method <code>setClass</code> introduces the name of the candidate
class in the type namespace. The method <code>declareImports</code>
introduces the names of the imported class or interface types in the type
namespace. Imported type names must be unique. When used (e.g. in a parameter
declaration, cast expression, etc.) a type name must be the name of the
candidate class, the name of a class or interface imported by method
<code>declareImports</code>, or denote a class or interface from the same
package as the candidate class.
<P>The method <code>setClass</code> introduces the names of the candidate
class fields.
<P>The method <code>declareParameters</code> introduces the names of the
parameters. A name introduced by <code>declareParameters</code> hides the
name of a candidate class field of the same name. Parameter names must be
unique.
<P>The method <code>declareVariables</code> introduces the names of the
variables. A name introduced by <code>declareVariables</code> hides the name
of a candidate class field if equal. Variable names must be unique and must
not conflict with parameter names.
<P>The result of the query by default is a list of result class instances,
but might be specified via <code>setResult</code>. The class of the result
by default is the candidate class, but might be specified via <code>setResultClass</code>.
<P>A hidden field may be accessed using the 'this' qualifier: <code>this.fieldName</code>.
<P>The <code>Query</code> interface provides methods which execute the query
based on the parameters given. They return a single instance or a
<code>List</code> of result class instances which the
user can iterate to get results. The signature
of the <code>execute</code> methods specifies that they return an
<code>Object</code> which must be cast to the appropriate result by the user.
<P>Any parameters passed to the <code>execute</code> methods are used only
for this execution, and are not remembered for future execution.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="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>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#JDOQL">JDOQL</a></span></code>
<div class="block">The string constant used as the first argument to
<a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-"><code>PersistenceManager.newQuery(String,Object)</code></a> to identify that the
created query should obey the JDOQL syntax and semantic rules.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#SQL">SQL</a></span></code>
<div class="block">The string constant used as the first argument to <a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-"><code>PersistenceManager.newQuery(String,Object)</code></a> to identify that
the created query should use SQL semantics.</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></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</code>
<div class="block">Add a vendor-specific extension to this query.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-">addSubquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.util.Map-">addSubquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-">addSubquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String-">addSubquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter)</code>
<div class="block">Add a subquery to this 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="../../javax/jdo/Query.html#cancel-java.lang.Thread-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a>&nbsp;thread)</code>
<div class="block">Method to cancel an executing query in the specified thread.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#cancelAll--">cancelAll</a></span>()</code>
<div class="block">Method to cancel any executing queries.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#close--">close</a></span>()</code>
<div class="block">Don't use this method directly; use <code>closeAll()</code> instead.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#close-java.lang.Object-">close</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;queryResult)</code>
<div class="block">Close a query result and release any resources associated with it.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#closeAll--">closeAll</a></span>()</code>
<div class="block">Close all query results associated with this <code>Query</code>
instance, and release all resources associated with them.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#compile--">compile</a></span>()</code>
<div class="block">Verify the elements of the query and provide a hint to the query to
prepare and optimize an execution plan.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#datastoreReadTimeoutMillis-java.lang.Integer-">datastoreReadTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</code>
<div class="block">Set the datastore read timeout (millis).</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#datastoreWriteTimeoutMillis-java.lang.Integer-">datastoreWriteTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</code>
<div class="block">Set the datastore write timeout (millis).</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#declareImports-java.lang.String-">declareImports</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;imports)</code>
<div class="block">Set the import statements to be used to identify the fully qualified
name of variables or parameters.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#declareParameters-java.lang.String-">declareParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameters)</code>
<div class="block">Declare the list of parameters query execution.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#declareVariables-java.lang.String-">declareVariables</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variables)</code>
<div class="block">Declare the unbound variables to be used in the query.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#deletePersistentAll--">deletePersistentAll</a></span>()</code>
<div class="block">Deletes all the instances of the candidate class that pass the
filter.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#deletePersistentAll-java.util.Map-">deletePersistentAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</code>
<div class="block">Deletes all the instances of the candidate class that pass the
filter.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#deletePersistentAll-java.lang.Object...-">deletePersistentAll</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;parameters)</code>
<div class="block">Deletes all the instances of the candidate class that pass the
filter.</div>
</td>
</tr>
<tr id="i19" 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="../../javax/jdo/Query.html#execute--">execute</a></span>()</code>
<div class="block">Execute the query and return the filtered Collection.</div>
</td>
</tr>
<tr id="i20" 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="../../javax/jdo/Query.html#execute-java.lang.Object-">execute</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;p1)</code>
<div class="block">Execute the query and return the filtered <code>Collection</code>.</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="../../javax/jdo/Query.html#execute-java.lang.Object-java.lang.Object-">execute</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;p1,
<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;p2)</code>
<div class="block">Execute the query and return the filtered <code>Collection</code>.</div>
</td>
</tr>
<tr id="i22" 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="../../javax/jdo/Query.html#execute-java.lang.Object-java.lang.Object-java.lang.Object-">execute</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;p1,
<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;p2,
<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;p3)</code>
<div class="block">Execute the query and return the filtered <code>Collection</code>.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#executeList--">executeList</a></span>()</code>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we are returning the candidate type.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#executeResultList--">executeResultList</a></span>()</code>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we have a result defined but no result class.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>&lt;R&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;R&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#executeResultList-java.lang.Class-">executeResultList</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;R&gt;&nbsp;resultCls)</code>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we are returning a result type for the specified result.</div>
</td>
</tr>
<tr id="i26" 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="../../javax/jdo/Query.html#executeResultUnique--">executeResultUnique</a></span>()</code>
<div class="block">Method to execute the query where there is a single row and we have a result defined but no result class.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>&lt;R&gt;&nbsp;R</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#executeResultUnique-java.lang.Class-">executeResultUnique</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;R&gt;&nbsp;resultCls)</code>
<div class="block">Method to execute the query where there is a single row and we are returning a result type for the specified result.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#executeUnique--">executeUnique</a></span>()</code>
<div class="block">Method to execute the query where there is a single row and we are returning the candidate type.</div>
</td>
</tr>
<tr id="i29" 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="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-">executeWithArray</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;parameters)</code>
<div class="block">Execute the query and return the filtered <code>Collection</code>.</div>
</td>
</tr>
<tr id="i30" 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="../../javax/jdo/Query.html#executeWithMap-java.util.Map-">executeWithMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</code>
<div class="block">Execute the query and return the filtered <code>Collection</code>.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#extension-java.lang.String-java.lang.Object-">extension</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</code>
<div class="block">Specify an extension for this query.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#extensions-java.util.Map-">extensions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;values)</code>
<div class="block">Specify a map of extensions for this query.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#filter-java.lang.String-">filter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter)</code>
<div class="block">Set the filter for the query.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getDatastoreReadTimeoutMillis--">getDatastoreReadTimeoutMillis</a></span>()</code>
<div class="block">Get the effective timeout setting for read operations.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getDatastoreWriteTimeoutMillis--">getDatastoreWriteTimeoutMillis</a></span>()</code>
<div class="block">Get the effective timeout setting for write operations.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getFetchPlan--">getFetchPlan</a></span>()</code>
<div class="block">Returns the <code>FetchPlan</code> used by this
<code>Query</code>.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getIgnoreCache--">getIgnoreCache</a></span>()</code>
<div class="block">Get the ignoreCache option setting.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getPersistenceManager--">getPersistenceManager</a></span>()</code>
<div class="block">Get the <code>PersistenceManager</code> associated with this
<code>Query</code>.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#getSerializeRead--">getSerializeRead</a></span>()</code>
<div class="block">Return the current value of the serializeRead property.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#groupBy-java.lang.String-">groupBy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</code>
<div class="block">Set the grouping expressions, optionally including a "having" clause.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#ignoreCache-boolean-">ignoreCache</a></span>(boolean&nbsp;flag)</code>
<div class="block">Set whether we to ignore the cache with this query.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#imports-java.lang.String-">imports</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;imports)</code>
<div class="block">Set the import statements to be used to identify the fully qualified name of variables or parameters.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#isUnmodifiable--">isUnmodifiable</a></span>()</code>
<div class="block">The unmodifiable flag, when set, disallows further
modification of the query, except for specifying the range,
result class, and ignoreCache option.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#orderBy-java.lang.String-">orderBy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ordering)</code>
<div class="block">Set the ordering specification for the result <code>Collection</code>.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#parameters-java.lang.String-">parameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameters)</code>
<div class="block">Declare the list of parameters for query execution.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#range-long-long-">range</a></span>(long&nbsp;fromIncl,
long&nbsp;toExcl)</code>
<div class="block">Set the range of results to return.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#range-java.lang.String-">range</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fromInclToExcl)</code>
<div class="block">Set the range of results to return.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#result-java.lang.String-">result</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;result)</code>
<div class="block">Set the result clause for the query.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#saveAsNamedQuery-java.lang.String-">saveAsNamedQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Save the query, as it is currently defined, as a named query under the specified name.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#serializeRead-java.lang.Boolean-">serializeRead</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;serialize)</code>
<div class="block">Set whether we to lock all objects read by this query.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setCandidates-java.util.Collection-">setCandidates</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;pcs)</code>
<div class="block">Set the candidate <code>Collection</code> to query.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setCandidates-javax.jdo.Extent-">setCandidates</a></span>(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;pcs)</code>
<div class="block">Set the candidate <code>Extent</code> to query.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setClass-java.lang.Class-">setClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;cls)</code>
<div class="block">Set the class of the candidate instances of the query.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setDatastoreReadTimeoutMillis-java.lang.Integer-">setDatastoreReadTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</code>
<div class="block">Specify a timeout interval (milliseconds) for any read operations
associated with this query.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-">setDatastoreWriteTimeoutMillis</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</code>
<div class="block">Specify a timeout interval (milliseconds) for any write operations
associated with this query.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setExtensions-java.util.Map-">setExtensions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;extensions)</code>
<div class="block">Set multiple extensions, or use null to clear all extensions.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setFilter-java.lang.String-">setFilter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter)</code>
<div class="block">Set the filter for the query.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setGrouping-java.lang.String-">setGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</code>
<div class="block">Set the grouping expressions, optionally including a "having"
clause.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setIgnoreCache-boolean-">setIgnoreCache</a></span>(boolean&nbsp;ignoreCache)</code>
<div class="block">Set the ignoreCache option.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setNamedParameters-java.util.Map-">setNamedParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;namedParamMap)</code>
<div class="block">Method to set the named parameters on this query prior to execution.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setOrdering-java.lang.String-">setOrdering</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ordering)</code>
<div class="block">Set the ordering specification for the result <code>Collection</code>.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setParameters-java.lang.Object...-">setParameters</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;paramValues)</code>
<div class="block">Method to set the values of the numbered parameters on this query prior to execution.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setRange-long-long-">setRange</a></span>(long&nbsp;fromIncl,
long&nbsp;toExcl)</code>
<div class="block">Set the range of results to return.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setRange-java.lang.String-">setRange</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fromInclToExcl)</code>
<div class="block">Set the range of results to return.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setResult-java.lang.String-">setResult</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;data)</code>
<div class="block">Specifies what type of data this query should return.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setResultClass-java.lang.Class-">setResultClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Specify the type of object in which to return each element of
the result of invoking <a href="../../javax/jdo/Query.html#execute--"><code>execute()</code></a> or one of its siblings.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setSerializeRead-java.lang.Boolean-">setSerializeRead</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;serialize)</code>
<div class="block">If <code>true</code>, a lock will be applied to all objects read in this
query.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setUnique-boolean-">setUnique</a></span>(boolean&nbsp;unique)</code>
<div class="block">Specify that only the first result of the query should be
returned, rather than a collection.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#setUnmodifiable--">setUnmodifiable</a></span>()</code>
<div class="block">The unmodifiable flag, when set, disallows further
modification of the query, except for specifying the range,
result class, and ignoreCache option.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-">subquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.util.Map-">subquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-">subquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String-">subquery</a></span>(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter)</code>
<div class="block">Add a subquery to this query.</div>
</td>
</tr>
<tr id="i74" class="altColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#unmodifiable--">unmodifiable</a></span>()</code>
<div class="block">Set whether to make this query unmodifiable.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/jdo/Query.html#variables-java.lang.String-">variables</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variables)</code>
<div class="block">Declare the unbound variables to be used in the query.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JDOQL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JDOQL</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> JDOQL</pre>
<div class="block">The string constant used as the first argument to
<a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-"><code>PersistenceManager.newQuery(String,Object)</code></a> to identify that the
created query should obey the JDOQL syntax and semantic rules.
<p>This is the default query language used when creating a query with any
of the other <a href="../../javax/jdo/PersistenceManager.html#newQuery--"><code>PersistenceManager.newQuery()</code></a> methods, except
<a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.Object-"><code>PersistenceManager.newQuery(Object)</code></a>, which uses the query
language of the compiled query template object passed to that method.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.Query.JDOQL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SQL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SQL</h4>
<pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SQL</pre>
<div class="block">The string constant used as the first argument to <a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-"><code>PersistenceManager.newQuery(String,Object)</code></a> to identify that
the created query should use SQL semantics. This is only
meaningful for relational JDO implementations.
<p>If this is used, the <code>Object</code> argument to the
<a href="../../javax/jdo/PersistenceManager.html#newQuery-java.lang.String-java.lang.Object-"><code>PersistenceManager.newQuery(String,Object)</code></a> method
should be a <code>String</code> containing a SQL
<code>SELECT</code> statement.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#javax.jdo.Query.SQL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClass</h4>
<pre>void&nbsp;setClass(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;cls)</pre>
<div class="block">Set the class of the candidate instances of the query.
<P>The class specifies the class
of the candidates of the query. Elements of the candidate collection
that are of the specified class are filtered before being
put into the result <code>Collection</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - the <code>Class</code> of the candidate instances.</dd>
</dl>
</li>
</ul>
<a name="setCandidates-javax.jdo.Extent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCandidates</h4>
<pre>void&nbsp;setCandidates(<a href="../../javax/jdo/Extent.html" title="interface in javax.jdo">Extent</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;pcs)</pre>
<div class="block">Set the candidate <code>Extent</code> to query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pcs</code> - the candidate <code>Extent</code>.</dd>
</dl>
</li>
</ul>
<a name="setCandidates-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCandidates</h4>
<pre>void&nbsp;setCandidates(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;pcs)</pre>
<div class="block">Set the candidate <code>Collection</code> to query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pcs</code> - the candidate <code>Collection</code>.</dd>
</dl>
</li>
</ul>
<a name="setFilter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilter</h4>
<pre>void&nbsp;setFilter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter)</pre>
<div class="block">Set the filter for the query.
<P>The filter specification is a <code>String</code> containing a Boolean
expression that is to be evaluated for each of the instances
in the candidate collection. If the filter is not specified,
then it defaults to "true", which has the effect of filtering
the input <code>Collection</code> only for class type.
<P>An element of the candidate collection is returned in the result if:
<ul><li>it is assignment compatible to the candidate <code>Class</code>
of the <code>Query</code>; and
<li>for all variables there exists a value for which the filter
expression evaluates to <code>true</code>.
</ul>
<P>The user may denote uniqueness in the filter expression by
explicitly declaring an expression (for example, <code>e1 != e2</code>).
<P>Rules for constructing valid expressions follow the Java
language, except for these differences:
<ul>
<li>Equality and ordering comparisons between primitives and instances
of wrapper classes are valid.
<li>Equality and ordering comparisons of <code>Date</code> fields and
<code>Date</code> parameters are valid.
<li>White space (non-printing characters space, tab, carriage
return, and line feed) is a separator and is otherwise ignored.
<li>The assignment operators <code>=</code>, <code>+=</code>, etc. and
pre- and post-increment and -decrement are not supported. Therefore,
there are no side effects from evaluation of any expressions.
<li>Methods, including object construction, are not supported, except
for <code>Collection.contains(Object o)</code>,
<code>Collection.isEmpty()</code>,
<code>String.startsWith(String s)</code>, and
<code>String.endsWith(String e)</code>. Implementations might choose to
support non-mutating method calls as non-standard extensions.
<li>Navigation through a <code>null</code>-valued field, which would
throw <code>NullPointerException</code>, is treated as if the filter
expression returned <code>false</code> for the evaluation of the current
set of variable values. Other values for variables might still qualify
the candidate instance for inclusion in the result set.
<li>Navigation through multi-valued fields (<code>Collection</code>
types) is specified using a variable declaration and the
<code>Collection.contains(Object o)</code> method.
</ul>
<P>Identifiers in the expression are considered to be in the name
space of the specified class, with the addition of declared imports,
parameters and variables. As in the Java language, <code>this</code> is a
reserved word which means the element of the collection being evaluated.
<P>Navigation through single-valued fields is specified by the Java
language syntax of <code>field_name.field_name....field_name</code>.
<P>A JDO implementation is allowed to reorder the filter expression
for optimization purposes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - the query filter.</dd>
</dl>
</li>
</ul>
<a name="declareImports-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareImports</h4>
<pre>void&nbsp;declareImports(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;imports)</pre>
<div class="block">Set the import statements to be used to identify the fully qualified
name of variables or parameters. Parameters and unbound variables might
come from a different class from the candidate class, and the names
need to be declared in an import statement to eliminate ambiguity.
Import statements are specified as a <code>String</code> with
semicolon-separated statements.
<P>The <code>String</code> parameter to this method follows the syntax of
the import statement of the Java language.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>imports</code> - import statements separated by semicolons.</dd>
</dl>
</li>
</ul>
<a name="declareParameters-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareParameters</h4>
<pre>void&nbsp;declareParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameters)</pre>
<div class="block">Declare the list of parameters query execution.
The parameter declaration is a <code>String</code> containing one or more
query parameter declarations separated with commas. Each parameter named
in the parameter declaration must be bound to a value when
the query is executed.
<P>The <code>String</code> parameter to this method follows the syntax
for formal parameters in the Java language.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the list of parameters separated by commas.</dd>
</dl>
</li>
</ul>
<a name="declareVariables-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareVariables</h4>
<pre>void&nbsp;declareVariables(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variables)</pre>
<div class="block">Declare the unbound variables to be used in the query. Variables
might be used in the filter, and these variables must be declared
with their type. The unbound variable declaration is a
<code>String</code> containing one or more unbound variable declarations
separated with semicolons. It follows the syntax for local variables in
the Java language.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variables</code> - the variables separated by semicolons.</dd>
</dl>
</li>
</ul>
<a name="setOrdering-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrdering</h4>
<pre>void&nbsp;setOrdering(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ordering)</pre>
<div class="block">Set the ordering specification for the result <code>Collection</code>.
The ordering specification is a <code>String</code> containing one or
more ordering declarations separated by commas.
<P>Each ordering declaration is the name of the field on which
to order the results followed by one of the following words:
"<code>ascending</code>" or "<code>descending</code>".
<P>The field must be declared in the candidate class or must be
a navigation expression starting with a field in the candidate class.
<P>Valid field types are primitive types except <code>boolean</code>;
wrapper types except <code>Boolean</code>; <code>BigDecimal</code>;
<code>BigInteger</code>; <code>String</code>; and <code>Date</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordering</code> - the ordering specification.</dd>
</dl>
</li>
</ul>
<a name="setIgnoreCache-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreCache</h4>
<pre>void&nbsp;setIgnoreCache(boolean&nbsp;ignoreCache)</pre>
<div class="block">Set the ignoreCache option. The default value for this option was
set by the <code>PersistenceManagerFactory</code> or the
<code>PersistenceManager</code> used to create this <code>Query</code>.
The ignoreCache option setting specifies whether the query should execute
entirely in the back end, instead of in the cache. If this flag is set
to <code>true</code>, an implementation might be able to optimize the
query execution by ignoring changed values in the cache. For optimistic
transactions, this can dramatically improve query response times.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ignoreCache</code> - the setting of the ignoreCache option.</dd>
</dl>
</li>
</ul>
<a name="getIgnoreCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreCache</h4>
<pre>boolean&nbsp;getIgnoreCache()</pre>
<div class="block">Get the ignoreCache option setting.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ignoreCache option setting.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#setIgnoreCache-boolean-"><code>setIgnoreCache(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="compile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compile</h4>
<pre>void&nbsp;compile()</pre>
<div class="block">Verify the elements of the query and provide a hint to the query to
prepare and optimize an execution plan.</div>
</li>
</ul>
<a name="execute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre><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;execute()</pre>
<div class="block">Execute the query and return the filtered Collection.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException
being thrown here</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-"><code>executeWithArray(Object[] parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="execute-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre><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;execute(<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;p1)</pre>
<div class="block">Execute the query and return the filtered <code>Collection</code>.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException
being thrown here</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p1</code> - the value of the first parameter declared.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-"><code>executeWithArray(Object[] parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="execute-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre><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;execute(<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;p1,
<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;p2)</pre>
<div class="block">Execute the query and return the filtered <code>Collection</code>.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException
being thrown here</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p1</code> - the value of the first parameter declared.</dd>
<dd><code>p2</code> - the value of the second parameter declared.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-"><code>executeWithArray(Object[] parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="execute-java.lang.Object-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre><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;execute(<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;p1,
<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;p2,
<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;p3)</pre>
<div class="block">Execute the query and return the filtered <code>Collection</code>.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException
being thrown here</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p1</code> - the value of the first parameter declared.</dd>
<dd><code>p2</code> - the value of the second parameter declared.</dd>
<dd><code>p3</code> - the value of the third parameter declared.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-"><code>executeWithArray(Object[] parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="executeWithMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeWithMap</h4>
<pre><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;executeWithMap(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</pre>
<div class="block">Execute the query and return the filtered <code>Collection</code>. The
query is executed with the parameters set by the <code>Map</code> values.
Each <code>Map</code> entry consists of a key which is the name of the
parameter in the <code>declareParameters</code> method, and a value which
is the value used in the <code>execute</code> method. The keys in the
<code>Map</code> and the declared parameters must exactly match or a
<code>JDOUserException</code> is thrown.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException
being thrown here</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the <code>Map</code> containing all of the parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#executeWithArray-java.lang.Object...-"><code>executeWithArray(Object[] parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="executeWithArray-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeWithArray</h4>
<pre><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;executeWithArray(<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;parameters)</pre>
<div class="block">Execute the query and return the filtered <code>Collection</code>.
<P>The execution of the query obtains the values of the parameters and
matches them against the declared parameters in order. The names
of the declared parameters are ignored. The type of
the declared parameters must match the type of the passed parameters,
except that the passed parameters might need to be unwrapped to get
their primitive values.
<P>The filter, import, declared parameters, declared variables, and
ordering statements are verified for consistency.
<P>Each element in the candidate <code>Collection</code> is examined to
see that it is assignment compatible to the <code>Class</code> of the
query. It is then evaluated by the Boolean expression of the filter.
The element passes the filter if there exist unique values for all
variables for which the filter expression evaluates to <code>true</code>.
<P>Cancellation of the query using cancel() will result in JDOQueryInterruptedException being thrown here</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the <code>Object</code> array with all of the parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filtered <code>Collection</code>.</dd>
</dl>
</li>
</ul>
<a name="getPersistenceManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistenceManager</h4>
<pre><a href="../../javax/jdo/PersistenceManager.html" title="interface in javax.jdo">PersistenceManager</a>&nbsp;getPersistenceManager()</pre>
<div class="block">Get the <code>PersistenceManager</code> associated with this
<code>Query</code>.
<P>If this <code>Query</code> was restored from a serialized form, it has
no <code>PersistenceManager</code>, and this method returns
<code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>PersistenceManager</code> associated with this
<code>Query</code>.</dd>
</dl>
</li>
</ul>
<a name="close-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close(<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;queryResult)</pre>
<div class="block">Close a query result and release any resources associated with it. The
parameter is the return from <code>execute(...)</code> and might have
iterators open on it. Iterators associated with the query result are
invalidated: they return <code>false</code> to <code>hasNext()</code>
and throw <code>NoSuchElementException</code> to <code>next()</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryResult</code> - the result of <code>execute(...)</code> on this
<code>Query</code> instance.</dd>
</dl>
</li>
</ul>
<a name="closeAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAll</h4>
<pre>void&nbsp;closeAll()</pre>
<div class="block">Close all query results associated with this <code>Query</code>
instance, and release all resources associated with them. The query
results might have iterators open on them. Iterators associated with the
query results are invalidated:
they return <code>false</code> to <code>hasNext()</code> and throw
<code>NoSuchElementException</code> to <code>next()</code>.</div>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Don't use this method directly; use <code>closeAll()</code> instead. It is intended for use with try-with-resources.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if this resource cannot be closed</dd>
</dl>
</li>
</ul>
<a name="setGrouping-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGrouping</h4>
<pre>void&nbsp;setGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</pre>
<div class="block">Set the grouping expressions, optionally including a "having"
clause. When grouping is specified, each result expression
must either be an expression contained in the grouping, or an
aggregate evaluated once per group.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>group</code> - a comma-delimited list of expressions, optionally
followed by the "having" keyword and a boolean expression</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setUnique-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnique</h4>
<pre>void&nbsp;setUnique(boolean&nbsp;unique)</pre>
<div class="block">Specify that only the first result of the query should be
returned, rather than a collection. The execute method will
return null if the query result size is 0.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unique</code> - if true, only one element is returned</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setResult-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResult</h4>
<pre>void&nbsp;setResult(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;data)</pre>
<div class="block">Specifies what type of data this query should return. If this
is unset or set to <code>null</code>, this query returns
instances of the query's candidate class. If set, this query
will return expressions, including field values (projections) and
aggregate function results.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - a comma-delimited list of expressions
(fields, functions on fields, or aggregate functions)
to return from this query</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setResultClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResultClass</h4>
<pre>void&nbsp;setResultClass(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Specify the type of object in which to return each element of
the result of invoking <a href="../../javax/jdo/Query.html#execute--"><code>execute()</code></a> or one of its siblings.
If the result is not set or set to null, the result class defaults
to the candidate class of the query. If the result consists of one
expression, the result class defaults to the type of that expression.
If the result consists of more than one expression, the result class
defaults to Object[].
The result class may be specified to be one of the java.lang classes
Character, Boolean, Byte, Short, Integer, Long, Float, Double, String,
or Object[]; or one of the java.math classes BigInteger or BigDecimal;
or the java.util class Date; or one of the java.sql classes Date,
Time, or Timestamp; or a user-defined class.
<P>If there are multiple result expressions, the result class
must be able to hold all elements of the result specification
or a JDOUserException is thrown.
<P>If there is only one result expression, the result class must be
assignable from the type of the result expression or must be able
to hold all elements of the result specification. A single value
must be able to be coerced into the specified result class
(treating wrapper classes as equivalent to their unwrapped
primitive types) or by matching. If the result class does not satisfy
these conditions, a JDOUserException is thrown.
<P>A constructor of a result class specified in the setResult method
will be used if the results specification matches the parameters
of the constructor by position and type. If more than one constructor
satisfies the requirements, the JDO implementation chooses one of them.
If no constructor satisfies the results requirements, or if the result
class is specified via the setResultClass method, the following
requirements apply:
<ul>
<li>A user-defined result class must have a no-args constructor and
one or more public <code>set</code> or <code>put</code> methods or
fields.
<li>Each result expression must match one of:
<ul>
<li>a public field that matches the name of the result expression
and is of the type (treating wrapper types equivalent to primitive
types) of the result expression;
<li>or if no public field matches the name and type, a public
<code>set</code> method that returns void and matches the name of the
result expression and takes a single parameter which is the
exact type of the result expression;
<li>or if neither of the above applies,a public method must be found
with the signature <code>void put(Object, Object)</code>.
During processing of the results,
the first argument is the name of the result expression and
the second argument is the value from the query result.
</ul>
</ul>
Portable result classes do not invoke any persistence behavior
during their no-args constructor or <code>set</code> methods.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - the result class</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setRange-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRange</h4>
<pre>void&nbsp;setRange(long&nbsp;fromIncl,
long&nbsp;toExcl)</pre>
<div class="block">Set the range of results to return. The execution of the query is
modified to return only a subset of results. If the filter would
normally return 100 instances, and fromIncl is set to 50, and
toExcl is set to 70, then the first 50 results that would have
been returned are skipped, the next 20 results are returned and the
remaining 30 results are ignored. An implementation should execute
the query such that the range algorithm is done at the data store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromIncl</code> - 0-based inclusive start index</dd>
<dd><code>toExcl</code> - 0-based exclusive end index, or
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setRange-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRange</h4>
<pre>void&nbsp;setRange(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fromInclToExcl)</pre>
<div class="block">Set the range of results to return. The parameter is a String
containing a comma-separated fromIncl and toExcl. The fromIncl and
toExcl can be either String representations of long values, or can
be parameters identified with a leading ":". For example,
<code>setRange("50, 70");</code> or
<code>setRange(":from, :to");</code> or
<code>setRange("50, :to");</code>.
The execution of the query is
modified to return only a subset of results. If the filter would
normally return 100 instances, and fromIncl is set to 50, and
toExcl is set to 70, then the first 50 results that would have
been returned are skipped, the next 20 results are returned and the
remaining 30 results are ignored. An implementation should execute
the query such that the range algorithm is done at the data store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromInclToExcl</code> - comma-separated fromIncl and toExcl values</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#setRange-long-long-"><code>setRange(long, long)</code></a></dd>
</dl>
</li>
</ul>
<a name="addExtension-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addExtension</h4>
<pre>void&nbsp;addExtension(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</pre>
<div class="block">Add a vendor-specific extension to this query. The key and value
are not standard.
An implementation must ignore keys that are not recognized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key of the extension</dd>
<dd><code>value</code> - the value of the extension</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setExtensions-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExtensions</h4>
<pre>void&nbsp;setExtensions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;extensions)</pre>
<div class="block">Set multiple extensions, or use null to clear all extensions.
Map keys and values are not standard.
An implementation must ignore entries that are not recognized.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extensions</code> - the map of extensions</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#addExtension-java.lang.String-java.lang.Object-"><code>addExtension(java.lang.String, java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="getFetchPlan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchPlan</h4>
<pre><a href="../../javax/jdo/FetchPlan.html" title="interface in javax.jdo">FetchPlan</a>&nbsp;getFetchPlan()</pre>
<div class="block">Returns the <code>FetchPlan</code> used by this
<code>Query</code>. Modifications of the returned fetch plan will not
cause this query's owning <code>PersistenceManager</code>'s
<code>FetchPlan</code> to be modified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fetch plan used by this query</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="deletePersistentAll-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePersistentAll</h4>
<pre>long&nbsp;deletePersistentAll(<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;parameters)</pre>
<div class="block">Deletes all the instances of the candidate class that pass the
filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - for the query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances of the candidate class that were deleted</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#deletePersistentAll--"><code>deletePersistentAll()</code></a></dd>
</dl>
</li>
</ul>
<a name="deletePersistentAll-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePersistentAll</h4>
<pre>long&nbsp;deletePersistentAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</pre>
<div class="block">Deletes all the instances of the candidate class that pass the
filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - for the query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances of the candidate class that were deleted</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#deletePersistentAll--"><code>deletePersistentAll()</code></a></dd>
</dl>
</li>
</ul>
<a name="deletePersistentAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletePersistentAll</h4>
<pre>long&nbsp;deletePersistentAll()</pre>
<div class="block">Deletes all the instances of the candidate class that pass the
filter. Returns the number of instances of the candidate
class that were deleted, specifically not including the number
of dependent and embedded instances.
<P>Dirty instances of affected classes in the cache are first
flushed to the datastore. Instances in the cache or brought into
the cache as a result of executing one of the
<code>deletePersistentAll</code>
methods undergo life cycle changes as if <code>deletePersistent</code>
were called on them.
<P>Specifically, if the class of deleted instances implements the
delete callback interface, the corresponding callback methods
are called on the deleted instances. Similarly, if there are
lifecycle listeners registered for delete events on affected
classes, the listener is called for each appropriate deleted instance.
<P>Before returning control to the application, instances of affected
classes in the cache are refreshed to reflect whether they were
deleted from the datastore.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances of the candidate class that were deleted</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="setUnmodifiable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnmodifiable</h4>
<pre>void&nbsp;setUnmodifiable()</pre>
<div class="block">The unmodifiable flag, when set, disallows further
modification of the query, except for specifying the range,
result class, and ignoreCache option.
The unmodifiable flag can also be set in metadata.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="isUnmodifiable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnmodifiable</h4>
<pre>boolean&nbsp;isUnmodifiable()</pre>
<div class="block">The unmodifiable flag, when set, disallows further
modification of the query, except for specifying the range,
result class, and ignoreCache option.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current setting of the flag</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
<a name="addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSubquery</h4>
<pre>void&nbsp;addSubquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression)</pre>
<div class="block">Add a subquery to this query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable in the outer query
to bind the results of the subquery</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection
of the subquery as an expression using terms of the outer query</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-"><code>addSubquery(Query sub, String variableDeclaration,
String candidateCollectionExpression, String... parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSubquery</h4>
<pre>void&nbsp;addSubquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter)</pre>
<div class="block">Add a subquery to this query.
The String version of the method binds the named expression
to the parameter implictly or explicitly declared in the
subquery.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable
to be used in this Query</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection
to apply to the subquery</dd>
<dd><code>parameter</code> - the expression from the outer query to bind
the parameter in the subquery</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-"><code>addSubquery(Query sub, String variableDeclaration,
String candidateCollectionExpression, String... parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSubquery</h4>
<pre>void&nbsp;addSubquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</pre>
<div class="block">Add a subquery to this query.
A subquery is composed as a Query and subsequently attached
to a different query (the outer query) by calling this method.
The query parameter instance is unmodified as a result of the
addSubquery or subsequent execution of the outer query.
Only some of the query parts are copied for use as the subquery.
The parts copied include the candidate class, filter, parameter
declarations, variable declarations, imports, ordering specification,
uniqueness, result specification, and grouping specification.
The association with a PersistenceManager, the candidate collection
or extent, result class, and range limits are not used.
The String parameters are trimmed of white space.
The variableDeclaration parameter is the name of the variable
containing the results of the subquery execution. If the same value
of variableDeclaration is used to add multiple subqueries, the
subquery replaces the previous subquery for the same named variable.
If the subquery parameter is null, the variable is unset,
effectively making the variable named in the variableDeclaration
unbound. If the trimmed value is the empty String, or the parameter
is null, then JDOUserException is thrown.
The candidateCollectionExpression is the expression from the
outer query that represents the candidates over which the subquery
is evaluated. If the trimmed value is the empty String, or the
parameter is null, then the candidate collection is the extent
of the candidate class.
The String... version of the method binds the named expressions in
turn to parameters in the order in which they are declared in the
subquery, or in the order they are found in the filter if not
explicitly declared in the subquery.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable in the outer query
to bind the results of the subquery</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection
of the subquery as an expression using terms of the outer query</dd>
<dd><code>parameters</code> - the expressions from the outer query to bind
the parameters in the subquery</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a name="addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSubquery</h4>
<pre>void&nbsp;addSubquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</pre>
<div class="block">Add a subquery to this query.
The Map version of the method treats the key of each map entry as
the name of the parameter in the subquery, with or without the
leading ":", and the value as the name of the expression in the
outer query. If the trimmed expression is the empty String for
either the parameter or the value of the String[], or for any
map key or value, that expression is ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable
to be used in this Query</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection
to apply to the subquery</dd>
<dd><code>parameters</code> - the expressions from the outer query to bind
the parameter in the subquery</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#addSubquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-"><code>addSubquery(Query sub, String variableDeclaration,
String candidateCollectionExpression, String... parameters)</code></a></dd>
</dl>
</li>
</ul>
<a name="setDatastoreReadTimeoutMillis-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatastoreReadTimeoutMillis</h4>
<pre>void&nbsp;setDatastoreReadTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</pre>
<div class="block">Specify a timeout interval (milliseconds) for any read operations
associated with this query. To unset the explicit timeout for this
query, specify null. For no timeout, specify 0.
If the datastore granularity is larger than milliseconds, the
timeout value will be rounded up to the nearest supported datastore
value.
If a read operation hasn't completed within this interval, executeXXX
will throw a JDODatastoreException.
If multiple datastore operations are required to complete the query,
the timeout value applies to each of them individually.
If the datastore and JDO implementation support timeouts, then
javax.jdo.option.DatastoreTimeout is returned by
PersistenceManagerFactory.supportedOptions().
If timeouts are not supported,this method will throw
JDOUnsupportedOptionException.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - the timeout interval (milliseconds)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getDatastoreReadTimeoutMillis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatastoreReadTimeoutMillis</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getDatastoreReadTimeoutMillis()</pre>
<div class="block">Get the effective timeout setting for read operations.
If the timeout has not been set on this query explicitly, the effective
datastore read timeout value from the persistence manager is returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the effective timeout setting (milliseconds).</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>setDatastoreReadTimeoutMillis(Integer)</code></a>,
<a href="../../javax/jdo/PersistenceManager.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>PersistenceManager.setDatastoreReadTimeoutMillis(Integer)</code></a></dd>
</dl>
</li>
</ul>
<a name="setDatastoreWriteTimeoutMillis-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatastoreWriteTimeoutMillis</h4>
<pre>void&nbsp;setDatastoreWriteTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</pre>
<div class="block">Specify a timeout interval (milliseconds) for any write operations
associated with this query. To unset the explicit timeout for this
query, specify null. For no timeout, specify 0.
If the datastore granularity is larger than milliseconds, the
timeout value will be rounded up to the nearest supported datastore
value.
If a write operation hasn't completed within this interval, deleteXXX
will throw a JDODatastoreException.
If multiple datastore operations are required to complete the query,
the timeout value applies to each of them individually.
If the datastore and JDO implementation support timeouts, then
javax.jdo.option.DatastoreTimeout is returned by
PersistenceManagerFactory.supportedOptions().
If timeouts are not supported,this method will throw
JDOUnsupportedOptionException.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - the timeout interval (milliseconds)</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getDatastoreWriteTimeoutMillis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatastoreWriteTimeoutMillis</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getDatastoreWriteTimeoutMillis()</pre>
<div class="block">Get the effective timeout setting for write operations.
If the timeout has not been set on this query explicitly, the effective
datastore write timeout value from the persistence manager is returned.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the effective timeout setting (milliseconds).</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../javax/jdo/Query.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>setDatastoreWriteTimeoutMillis(Integer)</code></a>,
<a href="../../javax/jdo/PersistenceManager.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>PersistenceManager.setDatastoreWriteTimeoutMillis(Integer)</code></a></dd>
</dl>
</li>
</ul>
<a name="cancelAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelAll</h4>
<pre>void&nbsp;cancelAll()</pre>
<div class="block">Method to cancel any executing queries.
If the underlying datastore doesn't support cancellation of queries this will
throw JDOUnsupportedOptionException.
If the cancellation fails (e.g in the underlying datastore) then this will throw
a JDOException.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="cancel-java.lang.Thread-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>void&nbsp;cancel(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a>&nbsp;thread)</pre>
<div class="block">Method to cancel an executing query in the specified thread.
If the underlying datastore doesn't support cancellation of queries this will
throw JDOUnsupportedOptionException.
If the cancellation fails (e.g in the underlying datastore) then this will throw
a JDOException.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>thread</code> - The thread to cancel</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="setSerializeRead-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSerializeRead</h4>
<pre>void&nbsp;setSerializeRead(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;serialize)</pre>
<div class="block">If <code>true</code>, a lock will be applied to all objects read in this
query.
<P>If <code>false</code> then retrieved objects will not be locked.
If null will fallback to the value for metadata for the class in question.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serialize</code> - the value of the serializeRead property</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getSerializeRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSerializeRead</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;getSerializeRead()</pre>
<div class="block">Return the current value of the serializeRead property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value of the serializeRead property</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="saveAsNamedQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveAsNamedQuery</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;saveAsNamedQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Save the query, as it is currently defined, as a named query under the specified name.
If a named query already exists under this name (either defined in metadata, or previously saved)
then it will be overwritten.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name to save it under.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="filter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;filter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;filter)</pre>
<div class="block">Set the filter for the query.
Shortcut for the <a href="../../javax/jdo/Query.html#setFilter-java.lang.String-"><code>setFilter(String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - the query filter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="orderBy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderBy</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;orderBy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ordering)</pre>
<div class="block">Set the ordering specification for the result <code>Collection</code>.
Shortcut for the <a href="../../javax/jdo/Query.html#setOrdering-java.lang.String-"><code>setOrdering(String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordering</code> - the ordering specification.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="groupBy-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupBy</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;groupBy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</pre>
<div class="block">Set the grouping expressions, optionally including a "having" clause.
Shortcut for the <a href="../../javax/jdo/Query.html#setGrouping-java.lang.String-"><code>setGrouping(String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>group</code> - a comma-delimited list of expressions, optionally followed by the "having" keyword and a boolean expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="result-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>result</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;result(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;result)</pre>
<div class="block">Set the result clause for the query.
Shortcut for the <a href="../../javax/jdo/Query.html#setResult-java.lang.String-"><code>setResult(String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - The result clause</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="range-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>range</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;range(long&nbsp;fromIncl,
long&nbsp;toExcl)</pre>
<div class="block">Set the range of results to return.
Shortcut for the <a href="../../javax/jdo/Query.html#setRange-long-long-"><code>setRange(long, long)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromIncl</code> - 0-based inclusive start index</dd>
<dd><code>toExcl</code> - 0-based exclusive end index, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="range-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>range</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;range(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fromInclToExcl)</pre>
<div class="block">Set the range of results to return.
Shortcut for the <a href="../../javax/jdo/Query.html#setRange-java.lang.String-"><code>setRange(String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromInclToExcl</code> - comma-separated fromIncl and toExcl values</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="subquery-javax.jdo.Query-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subquery</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;subquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression)</pre>
<div class="block">Add a subquery to this query.
Shortcut for the <a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-"><code>subquery(Query, String, String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable in the outer query to bind the results of the subquery</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection of the subquery as an expression using terms of the outer query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subquery</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;subquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter)</pre>
<div class="block">Add a subquery to this query.
Shortcut for the <a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String-"><code>subquery(Query, String, String, String)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable to be used in this Query</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection to apply to the subquery</dd>
<dd><code>parameter</code> - the expression from the outer query to bind the parameter in the subquery</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subquery</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;subquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</pre>
<div class="block">Add a subquery to this query.
Shortcut for the <a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.lang.String...-"><code>subquery(Query, String, String, String...)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable in the outer query to bind the results of the subquery</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection of the subquery as an expression using terms of the outer query</dd>
<dd><code>parameters</code> - the expressions from the outer query to bind the parameters in the subquery</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subquery</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;subquery(<a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&nbsp;sub,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableDeclaration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;candidateCollectionExpression,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;parameters)</pre>
<div class="block">Add a subquery to this query.
Shortcut for the <a href="../../javax/jdo/Query.html#subquery-javax.jdo.Query-java.lang.String-java.lang.String-java.util.Map-"><code>subquery(Query, String, String, Map)</code></a> method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sub</code> - the subquery to add to this Query</dd>
<dd><code>variableDeclaration</code> - the name of the variable to be used in this Query</dd>
<dd><code>candidateCollectionExpression</code> - the candidate collection to apply to the subquery</dd>
<dd><code>parameters</code> - the expressions from the outer query to bind the parameter in the subquery</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="imports-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>imports</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;imports(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;imports)</pre>
<div class="block">Set the import statements to be used to identify the fully qualified name of variables or parameters.
Shortcut for <a href="../../javax/jdo/Query.html#declareImports-java.lang.String-"><code>declareImports(String)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>imports</code> - the imports declaration</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="parameters-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;parameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameters)</pre>
<div class="block">Declare the list of parameters for query execution.
Shortcut for <a href="../../javax/jdo/Query.html#declareParameters-java.lang.String-"><code>declareParameters(String)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the list of parameters separated by commas.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="variables-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>variables</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;variables(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variables)</pre>
<div class="block">Declare the unbound variables to be used in the query.
Shortcut for <a href="../../javax/jdo/Query.html#declareVariables-java.lang.String-"><code>declareVariables(String)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variables</code> - the variables separated by semicolons.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="datastoreReadTimeoutMillis-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>datastoreReadTimeoutMillis</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;datastoreReadTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</pre>
<div class="block">Set the datastore read timeout (millis).
Shortcut for <a href="../../javax/jdo/Query.html#setDatastoreReadTimeoutMillis-java.lang.Integer-"><code>setDatastoreReadTimeoutMillis(Integer)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - The interval</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="datastoreWriteTimeoutMillis-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>datastoreWriteTimeoutMillis</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;datastoreWriteTimeoutMillis(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;interval)</pre>
<div class="block">Set the datastore write timeout (millis).
Shortcut for <a href="../../javax/jdo/Query.html#setDatastoreWriteTimeoutMillis-java.lang.Integer-"><code>setDatastoreWriteTimeoutMillis(Integer)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - The interval</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="serializeRead-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeRead</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;serializeRead(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;serialize)</pre>
<div class="block">Set whether we to lock all objects read by this query.
Shortcut for <a href="../../javax/jdo/Query.html#setSerializeRead-java.lang.Boolean-"><code>setSerializeRead(Boolean)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serialize</code> - Whether to lock</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="unmodifiable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unmodifiable</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;unmodifiable()</pre>
<div class="block">Set whether to make this query unmodifiable.
Shortcut for <a href="../../javax/jdo/Query.html#setUnmodifiable--"><code>setUnmodifiable()</code></a> method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="ignoreCache-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreCache</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;ignoreCache(boolean&nbsp;flag)</pre>
<div class="block">Set whether we to ignore the cache with this query.
Shortcut for <a href="../../javax/jdo/Query.html#setIgnoreCache-boolean-"><code>setIgnoreCache(boolean)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flag</code> - Whether to ignore the cache</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="extension-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extension</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;extension(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;key,
<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;value)</pre>
<div class="block">Specify an extension for this query.
Shortcut for <a href="../../javax/jdo/Query.html#addExtension-java.lang.String-java.lang.Object-"><code>addExtension(String, Object)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The extension key</dd>
<dd><code>value</code> - The extension value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="extensions-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensions</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;extensions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;values)</pre>
<div class="block">Specify a map of extensions for this query.
Shortcut for <a href="../../javax/jdo/Query.html#setExtensions-java.util.Map-"><code>setExtensions(Map)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The extension map of keys and values</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="setNamedParameters-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNamedParameters</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;setNamedParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;namedParamMap)</pre>
<div class="block">Method to set the named parameters on this query prior to execution.
If using the execute methods taking parameters then those parameter values will override these values.
All parameter values specified in this method will only be retained until the subsequent query execution.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>namedParamMap</code> - The map of parameter values keyed by their names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="setParameters-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameters</h4>
<pre><a href="../../javax/jdo/Query.html" title="interface in javax.jdo">Query</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;setParameters(<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;paramValues)</pre>
<div class="block">Method to set the values of the numbered parameters on this query prior to execution.
If using the execute methods taking parameters then those parameter values will override these values.
All parameter values specified in this method will only be retained until the subsequent query execution.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paramValues</code> - Values of the numbered parameters, in order.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This query</dd>
</dl>
</li>
</ul>
<a name="executeList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeList</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&gt;&nbsp;executeList()</pre>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we are returning the candidate type.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with a result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The List of candidate objects</dd>
</dl>
</li>
</ul>
<a name="executeUnique--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeUnique</h4>
<pre><a href="../../javax/jdo/Query.html" title="type parameter in Query">T</a>&nbsp;executeUnique()</pre>
<div class="block">Method to execute the query where there is a single row and we are returning the candidate type.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with a result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The candidate object returned by the query (or null)</dd>
</dl>
</li>
</ul>
<a name="executeResultList-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeResultList</h4>
<pre>&lt;R&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;R&gt;&nbsp;executeResultList(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;R&gt;&nbsp;resultCls)</pre>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we are returning a result type for the specified result.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with no result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - The result type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resultCls</code> - The result class</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of result objects</dd>
</dl>
</li>
</ul>
<a name="executeResultUnique-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeResultUnique</h4>
<pre>&lt;R&gt;&nbsp;R&nbsp;executeResultUnique(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;R&gt;&nbsp;resultCls)</pre>
<div class="block">Method to execute the query where there is a single row and we are returning a result type for the specified result.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with no result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - The result type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resultCls</code> - The result class</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result object (or null)</dd>
</dl>
</li>
</ul>
<a name="executeResultList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeResultList</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;executeResultList()</pre>
<div class="block">Method to execute the query where there are (potentially) multiple rows and we have a result defined but no result class.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with no result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of query results</dd>
</dl>
</li>
</ul>
<a name="executeResultUnique--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeResultUnique</h4>
<pre><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;executeResultUnique()</pre>
<div class="block">Method to execute the query where there is a single row and we have a result defined but no result class.
Any parameters required should be set prior to calling this method, using one of the <cite>setParameters</cite> methods.
<P>Calling this method with no result being specified will result in JDOUserException being thrown.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The query result (or null)</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<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="class-use/Query.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../javax/jdo/PersistenceManagerFactory.html" title="interface in javax.jdo"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../javax/jdo/Transaction.html" title="interface in javax.jdo"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?javax/jdo/Query.html" target="_top">Frames</a></li>
<li><a href="Query.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>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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>