blob: d2a75302e7656e1c6953ce60d2b8de2e5c91f0ef [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:07 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StoredProcedureQuery (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="StoredProcedureQuery (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoredProcedureQuery.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/SQLStoreQuery.SQLExecutor.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.StoredProcedureQueryExecutor.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html" target="_top">Frames</a></li>
<li><a href="StoredProcedureQuery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.openjpa.kernel.AbstractStoreQuery">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.jdbc.kernel</div>
<h2 title="Class StoredProcedureQuery" class="title">Class StoredProcedureQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">org.apache.openjpa.kernel.AbstractStoreQuery</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.jdbc.kernel.StoredProcedureQuery</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StoredProcedureQuery</span>
extends <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></pre>
<div class="block">Executes a stored procedure.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>ppoddar</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.openjpa.jdbc.kernel.StoredProcedureQuery">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.StoredProcedureQueryExecutor.html" title="class in org.apache.openjpa.jdbc.kernel">StoredProcedureQuery.StoredProcedureQueryExecutor</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.openjpa.kernel.AbstractStoreQuery">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.AbstractExecutor.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery.AbstractExecutor</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.openjpa.kernel.StoreQuery">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.AbstractStoreQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#ctx">ctx</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.StoreQuery">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_BOOLEANS">EMPTY_BOOLEANS</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_CLASSES">EMPTY_CLASSES</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_METAS">EMPTY_METAS</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_OBJECTS">EMPTY_OBJECTS</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_ORDERED_PARAMS">EMPTY_ORDERED_PARAMS</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_PARAMS">EMPTY_PARAMS</a>, <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_STRINGS">EMPTY_STRINGS</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.QueryOperations">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_DELETE">OP_DELETE</a>, <a href="../../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_SELECT">OP_SELECT</a>, <a href="../../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_UPDATE">OP_UPDATE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#StoredProcedureQuery-org.apache.openjpa.jdbc.kernel.JDBCStore-">StoredProcedureQuery</a></span>(<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</code>&nbsp;</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#getDictionary--">getDictionary</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#getOperation--">getOperation</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/sql/StoredProcedure.html" title="class in org.apache.openjpa.jdbc.sql">StoredProcedure</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#getProcedure--">getProcedure</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newDataStoreExecutor</a></span>(<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;subclasses)</code>
<div class="block">Return an executor for datastore execution of this query.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#requiresCandidateType--">requiresCandidateType</a></span>()</code>
<div class="block">Whether this query requires a candidate class.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#requiresParameterDeclarations--">requiresParameterDeclarations</a></span>()</code>
<div class="block">Whether this query requires parameters to be declared.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#setQuery-java.lang.Object-">setQuery</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;meta)</code>
<div class="block">This is invoked when the user or a facade creates a new query with
an object that the system does not recognize.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#supportsDataStoreExecution--">supportsDataStoreExecution</a></span>()</code>
<div class="block">True if this query supports datastore execution, false if it
can only run in memory.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html#supportsParameterDeclarations--">supportsParameterDeclarations</a></span>()</code>
<div class="block">Whether this query supports declared parameters.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.AbstractStoreQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#evaluate-java.lang.Object-java.lang.Object-java.lang.Object:A-org.apache.openjpa.kernel.OpenJPAStateManager-">evaluate</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#getAggregateListener-java.lang.String-">getAggregateListener</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#getCompilation--">getCompilation</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#getContext--">getContext</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#getFilterListener-java.lang.String-">getFilterListener</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#invalidateCompilation--">invalidateCompilation</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#newCompilation--">newCompilation</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#newCompilationKey--">newCompilationKey</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#newInMemoryExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newInMemoryExecutor</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#populateFromCompilation-java.lang.Object-">populateFromCompilation</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#setContext-org.apache.openjpa.kernel.QueryContext-">setContext</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#supportsAbstractExecutors--">supportsAbstractExecutors</a>, <a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#supportsInMemoryExecution--">supportsInMemoryExecution</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StoredProcedureQuery-org.apache.openjpa.jdbc.kernel.JDBCStore-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StoredProcedureQuery</h4>
<pre>public&nbsp;StoredProcedureQuery(<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getOperation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperation</h4>
<pre>public&nbsp;int&nbsp;getOperation()</pre>
</li>
</ul>
<a name="getProcedure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcedure</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/jdbc/sql/StoredProcedure.html" title="class in org.apache.openjpa.jdbc.sql">StoredProcedure</a>&nbsp;getProcedure()</pre>
</li>
</ul>
<a name="getDictionary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDictionary</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a>&nbsp;getDictionary()</pre>
</li>
</ul>
<a name="setQuery-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuery</h4>
<pre>public&nbsp;boolean&nbsp;setQuery(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;meta)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#setQuery-java.lang.Object-">StoreQuery</a></code></span></div>
<div class="block">This is invoked when the user or a facade creates a new query with
an object that the system does not recognize. Return true if
the object is recognized by the store, false otherwise.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#setQuery-java.lang.Object-">setQuery</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#setQuery-java.lang.Object-">setQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newDataStoreExecutor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a>&nbsp;newDataStoreExecutor(<a href="../../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;subclasses)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">StoreQuery</a></code></span></div>
<div class="block">Return an executor for datastore execution of this query.
Executors must be cachable and thread safe. If this class returns
true from <a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors--"><code>StoreQuery.supportsAbstractExecutors()</code></a>, the given metadata
will always be for the candidate class of this query, or possibly
null if the candidate class is not itself persistence capable (like
an interface or abstract base class). Otherwise, the given type will
be a mapped class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newDataStoreExecutor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newDataStoreExecutor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></dd>
<dd><code>subclasses</code> - whether to include dependent mapped subclasses in the
results; independent subclasses should never be included</dd>
</dl>
</li>
</ul>
<a name="supportsParameterDeclarations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsParameterDeclarations</h4>
<pre>public&nbsp;boolean&nbsp;supportsParameterDeclarations()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsParameterDeclarations--">StoreQuery</a></code></span></div>
<div class="block">Whether this query supports declared parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsParameterDeclarations--">supportsParameterDeclarations</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#supportsParameterDeclarations--">supportsParameterDeclarations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="supportsDataStoreExecution--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsDataStoreExecution</h4>
<pre>public&nbsp;boolean&nbsp;supportsDataStoreExecution()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsDataStoreExecution--">StoreQuery</a></code></span></div>
<div class="block">True if this query supports datastore execution, false if it
can only run in memory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsDataStoreExecution--">supportsDataStoreExecution</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#supportsDataStoreExecution--">supportsDataStoreExecution</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="requiresCandidateType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiresCandidateType</h4>
<pre>public&nbsp;boolean&nbsp;requiresCandidateType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresCandidateType--">StoreQuery</a></code></span></div>
<div class="block">Whether this query requires a candidate class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresCandidateType--">requiresCandidateType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#requiresCandidateType--">requiresCandidateType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="requiresParameterDeclarations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>requiresParameterDeclarations</h4>
<pre>public&nbsp;boolean&nbsp;requiresParameterDeclarations()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresParameterDeclarations--">StoreQuery</a></code></span></div>
<div class="block">Whether this query requires parameters to be declared.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresParameterDeclarations--">requiresParameterDeclarations</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html#requiresParameterDeclarations--">requiresParameterDeclarations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a></code></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/StoredProcedureQuery.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/SQLStoreQuery.SQLExecutor.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.StoredProcedureQueryExecutor.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html" target="_top">Frames</a></li>
<li><a href="StoredProcedureQuery.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.openjpa.kernel.AbstractStoreQuery">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>