Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / query / ProcedureQuery.html
blob: 476e2fa27f25bd94e9c0ca33e46296f9cf5b8e8a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:14 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ProcedureQuery (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-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="ProcedureQuery (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":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/ProcedureQuery.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/cayenne/query/ProcedureCall.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/ProcedureQuery.html" target="_top">Frames</a></li>
<li><a href="ProcedureQuery.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.query</div>
<h2 title="Class ProcedureQuery" class="title">Class ProcedureQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/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/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.CacheableQuery</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.query.ProcedureQuery</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ProcedureQuery</span>
extends <a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a>
implements <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></pre>
<div class="block">A query based on Procedure. Can be used as a select query, or as a query of an
arbitrary complexity, performing data modification, selecting data (possibly with
multiple result sets per call), returning values via OUT parameters.
<h3>Execution with DataContext</h3>
<h4>Reading OUT parameters</h4>
<p>
If a ProcedureQuery has OUT parameters, they are wrapped in a separate List in the
query result. Such list will contain a single Map with OUT parameter values.
</p>
<h4>Using ProcedureQuery as a GenericSelectQuery</h4>
<p>
Executing ProcedureQuery via
<a href="../../../../org/apache/cayenne/access/DataContext.html#performQuery-org.apache.cayenne.query.Query-"><code>DataContext.performQuery(Query)</code></a> makes sense only if
the stored procedure returns a single result set (or alternatively returns a result via
OUT parameters and no other result sets). It is still OK if data modification occurs as
a side effect. However if the query returns more then one result set, a more generic
form should be used:
<a href="../../../../org/apache/cayenne/access/DataContext.html#performGenericQuery-org.apache.cayenne.query.Query-"><code>DataContext.performGenericQuery(Query)</code></a>.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.ProcedureQuery">Serialized Form</a></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/7/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="../../../../org/apache/cayenne/query/ProcedureQuery.html#COLUMN_NAME_CAPITALIZATION_PROPERTY">COLUMN_NAME_CAPITALIZATION_PROPERTY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#columnNamesCapitalization">columnNamesCapitalization</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/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="../../../../org/apache/cayenne/query/ProcedureQuery.html#parameters">parameters</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultClass">resultClass</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultDescriptors">resultDescriptors</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/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="../../../../org/apache/cayenne/query/ProcedureQuery.html#resultEntityName">resultEntityName</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.AbstractQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3>
<code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#dataMap">dataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.CacheableQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3>
<code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#logger">logger</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/cayenne/query/ProcedureQuery.html#ProcedureQuery--">ProcedureQuery</a></span>()</code>
<div class="block">Creates an empty procedure query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-org.apache.cayenne.map.Procedure-">ProcedureQuery</a></span>(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure)</code>
<div class="block">Creates a ProcedureQuery based on a Procedure object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-org.apache.cayenne.map.Procedure-java.lang.Class-">ProcedureQuery</a></span>(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;resultType)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-java.lang.String-">ProcedureQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;procedureName)</code>
<div class="block">Creates a ProcedureQuery based on a stored procedure.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-java.lang.String-java.lang.Class-">ProcedureQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;procedureName,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;resultType)</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addParameter-java.lang.String-java.lang.Object-">addParameter</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Adds a named parameter to the internal map of parameters.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addPrefetch-java.lang.String-">addPrefetch</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefetchPath)</code>
<div class="block">Adds a prefetch.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addPrefetches-java.util.Collection-">addPrefetches</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;prefetches)</code>
<div class="block">Adds all prefetches from a provided collection.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#addResultDescriptor-org.apache.cayenne.access.jdbc.ColumnDescriptor:A-">addResultDescriptor</a></span>(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</code>
<div class="block">Adds a descriptor for a single ResultSet.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#clearParameters--">clearParameters</a></span>()</code>
<div class="block">Cleans up all configured parameters.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#clearPrefetches--">clearPrefetches</a></span>()</code>
<div class="block">Clears all prefetches.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#createQuery-java.util.Map-">createQuery</a></span>(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;parameters)</code>
<div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and
substituting template parameters with the values from the map.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></span>(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</code>
<div class="block">Calls "makeProcedure" on the visitor.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></span>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder)</code>
<div class="block">Prints itself as XML to the provided PrintWriter.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected org.apache.cayenne.query.BaseQueryMetadata</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getBaseMetaData--">getBaseMetaData</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getColumnNamesCapitalization--">getColumnNamesCapitalization</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getFetchLimit--">getFetchLimit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getFetchOffset--">getFetchOffset</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></span>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</code>
<div class="block">Returns default select parameters.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getPageSize--">getPageSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getParameters--">getParameters</a></span>()</code>
<div class="block">Returns a map of procedure parameters.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getPrefetchTree--">getPrefetchTree</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultDescriptors--">getResultDescriptors</a></span>()</code>
<div class="block">Returns a List of descriptors for query ResultSets in the order they are returned
by the stored procedure.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/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="../../../../org/apache/cayenne/query/ProcedureQuery.html#getResultEntityName--">getResultEntityName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#getStatementFetchSize--">getStatementFetchSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#initWithProperties-java.util.Map-">initWithProperties</a></span>(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;properties)</code>
<div class="block">Initializes query parameters using a set of properties.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#isFetchingDataRows--">isFetchingDataRows</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removeParameter-java.lang.String-">removeParameter</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removePrefetch-java.lang.String-">removePrefetch</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefetch)</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#removeResultDescriptor-org.apache.cayenne.access.jdbc.ColumnDescriptor:A-">removeResultDescriptor</a></span>(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</code>
<div class="block">Removes result descriptor from the list of descriptors.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setColumnNamesCapitalization-org.apache.cayenne.query.CapsStrategy-">setColumnNamesCapitalization</a></span>(<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;columnNameCapitalization)</code>&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows-boolean-">setFetchingDataRows</a></span>(boolean&nbsp;flag)</code>&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchLimit-int-">setFetchLimit</a></span>(int&nbsp;fetchLimit)</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchOffset-int-">setFetchOffset</a></span>(int&nbsp;fetchOffset)</code>&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setPageSize-int-">setPageSize</a></span>(int&nbsp;pageSize)</code>&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setParameters-java.util.Map-">setParameters</a></span>(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;parameters)</code>
<div class="block">Sets a map of parameters.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName-java.lang.String-">setResultEntityName</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resultEntityName)</code>&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setStatementFetchSize-int-">setStatementFetchSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets statement's fetch size (0 for no default size)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.AbstractQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3>
<code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getRoot--">getRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setDataMap-org.apache.cayenne.map.DataMap-">setDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setRoot-java.lang.Object-">setRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.CacheableQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3>
<code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheGroup--">getCacheGroup</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheGroups--">getCacheGroups</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheStrategy--">getCacheStrategy</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheGroup-java.lang.String-">setCacheGroup</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheGroups-java.lang.String...-">setCacheGroups</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheStrategy-org.apache.cayenne.query.QueryCacheStrategy-">setCacheStrategy</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache--">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache-java.lang.String...-">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache-java.lang.String-">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache--">useSharedCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache-java.lang.String...-">useSharedCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache-java.lang.String-">useSharedCache</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.Query">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></h3>
<code><a href="../../../../org/apache/cayenne/query/Query.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/Query.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="COLUMN_NAME_CAPITALIZATION_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COLUMN_NAME_CAPITALIZATION_PROPERTY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COLUMN_NAME_CAPITALIZATION_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.cayenne.query.ProcedureQuery.COLUMN_NAME_CAPITALIZATION_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="resultEntityName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resultEntityName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resultEntityName</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="resultClass">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resultClass</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt; resultClass</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="columnNamesCapitalization">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnNamesCapitalization</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> columnNamesCapitalization</pre>
</li>
</ul>
<a name="parameters">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt; parameters</pre>
</li>
</ul>
<a name="resultDescriptors">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resultDescriptors</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt; resultDescriptors</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProcedureQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery()</pre>
<div class="block">Creates an empty procedure query. The query would fetch DataRows. Fetching
Persistent objects can be achieved either by using
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-java.lang.String-java.lang.Class-"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows-boolean-"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName-java.lang.String-"><code>setResultEntityName(String)</code></a>
methods.</div>
</li>
</ul>
<a name="ProcedureQuery-org.apache.cayenne.map.Procedure-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure)</pre>
<div class="block">Creates a ProcedureQuery based on a Procedure object. The query would fetch
DataRows. Fetching Persistent objects can be achieved either by using
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-java.lang.String-java.lang.Class-"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows-boolean-"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName-java.lang.String-"><code>setResultEntityName(String)</code></a>
methods.</div>
</li>
</ul>
<a name="ProcedureQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;procedureName)</pre>
<div class="block">Creates a ProcedureQuery based on a stored procedure. The query would fetch
DataRows. Fetching Persistent objects can be achieved either by using
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#ProcedureQuery-java.lang.String-java.lang.Class-"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setFetchingDataRows-boolean-"><code>setFetchingDataRows(boolean)</code></a> and <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html#setResultEntityName-java.lang.String-"><code>setResultEntityName(String)</code></a>
methods.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>procedureName</code> - A name of the stored procedure. For this query to work, a
procedure with this name must be mapped in Cayenne.</dd>
</dl>
</li>
</ul>
<a name="ProcedureQuery-org.apache.cayenne.map.Procedure-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery(<a href="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;resultType)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="ProcedureQuery-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;procedureName,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;resultType)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</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="getMetaData-org.apache.cayenne.map.EntityResolver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaData</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a>&nbsp;getMetaData(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">AbstractQuery</a></code></span></div>
<div class="block">Returns default select parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/Query.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="getResultDescriptors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultDescriptors</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;&nbsp;getResultDescriptors()</pre>
<div class="block">Returns a List of descriptors for query ResultSets in the order they are returned
by the stored procedure.
<p>
<i>Note that if a procedure returns ResultSet in an OUT parameter, it is returned
prior to any other result sets (though in practice database engines usually support
only one mechanism for returning result sets. </i>
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="addResultDescriptor-org.apache.cayenne.access.jdbc.ColumnDescriptor:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addResultDescriptor</h4>
<pre>public&nbsp;void&nbsp;addResultDescriptor(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</pre>
<div class="block">Adds a descriptor for a single ResultSet. More than one descriptor can be added by
calling this method multiple times in the order of described ResultSet appearance
in the procedure results.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="removeResultDescriptor-org.apache.cayenne.access.jdbc.ColumnDescriptor:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeResultDescriptor</h4>
<pre>public&nbsp;void&nbsp;removeResultDescriptor(<a href="../../../../org/apache/cayenne/access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</pre>
<div class="block">Removes result descriptor from the list of descriptors.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSQLAction</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;createSQLAction(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</pre>
<div class="block">Calls "makeProcedure" on the visitor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="initWithProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initWithProperties</h4>
<pre>public&nbsp;void&nbsp;initWithProperties(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;properties)</pre>
<div class="block">Initializes query parameters using a set of properties.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="encodeAsXML-org.apache.cayenne.util.XMLEncoder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeAsXML</h4>
<pre>public&nbsp;void&nbsp;encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder)</pre>
<div class="block">Prints itself as XML to the provided PrintWriter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="createQuery-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;createQuery(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;parameters)</pre>
<div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and
substituting template parameters with the values from the map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html#createQuery-java.util.Map-">createQuery</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getBaseMetaData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseMetaData</h4>
<pre>protected&nbsp;org.apache.cayenne.query.BaseQueryMetadata&nbsp;getBaseMetaData()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getBaseMetaData--">getBaseMetaData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></code></dd>
</dl>
</li>
</ul>
<a name="getFetchLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchLimit</h4>
<pre>public&nbsp;int&nbsp;getFetchLimit()</pre>
</li>
</ul>
<a name="setFetchLimit-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchLimit</h4>
<pre>public&nbsp;void&nbsp;setFetchLimit(int&nbsp;fetchLimit)</pre>
</li>
</ul>
<a name="getFetchOffset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchOffset</h4>
<pre>public&nbsp;int&nbsp;getFetchOffset()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="setFetchOffset-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchOffset</h4>
<pre>public&nbsp;void&nbsp;setFetchOffset(int&nbsp;fetchOffset)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getPageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageSize</h4>
<pre>public&nbsp;int&nbsp;getPageSize()</pre>
</li>
</ul>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre>public&nbsp;void&nbsp;setPageSize(int&nbsp;pageSize)</pre>
</li>
</ul>
<a name="setFetchingDataRows-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchingDataRows</h4>
<pre>public&nbsp;void&nbsp;setFetchingDataRows(boolean&nbsp;flag)</pre>
</li>
</ul>
<a name="isFetchingDataRows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFetchingDataRows</h4>
<pre>public&nbsp;boolean&nbsp;isFetchingDataRows()</pre>
</li>
</ul>
<a name="addParameter-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre>public&nbsp;void&nbsp;addParameter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Adds a named parameter to the internal map of parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="removeParameter-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParameter</h4>
<pre>public&nbsp;void&nbsp;removeParameter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;getParameters()</pre>
<div class="block">Returns a map of procedure parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="setParameters-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameters</h4>
<pre>public&nbsp;void&nbsp;setParameters(<a href="https://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?&gt;&nbsp;parameters)</pre>
<div class="block">Sets a map of parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="clearParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearParameters</h4>
<pre>public&nbsp;void&nbsp;clearParameters()</pre>
<div class="block">Cleans up all configured parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="getPrefetchTree--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrefetchTree</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a>&nbsp;getPrefetchTree()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="addPrefetch-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPrefetch</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a>&nbsp;addPrefetch(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefetchPath)</pre>
<div class="block">Adds a prefetch.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="removePrefetch-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePrefetch</h4>
<pre>public&nbsp;void&nbsp;removePrefetch(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;prefetch)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="addPrefetches-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPrefetches</h4>
<pre>public&nbsp;void&nbsp;addPrefetches(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;prefetches)</pre>
<div class="block">Adds all prefetches from a provided collection.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="clearPrefetches--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearPrefetches</h4>
<pre>public&nbsp;void&nbsp;clearPrefetches()</pre>
<div class="block">Clears all prefetches.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="getResultEntityName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultEntityName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getResultEntityName()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="setResultEntityName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResultEntityName</h4>
<pre>public&nbsp;void&nbsp;setResultEntityName(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;resultEntityName)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a name="getColumnNamesCapitalization--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNamesCapitalization</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;getColumnNamesCapitalization()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="setColumnNamesCapitalization-org.apache.cayenne.query.CapsStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnNamesCapitalization</h4>
<pre>public&nbsp;void&nbsp;setColumnNamesCapitalization(<a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;columnNameCapitalization)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="setStatementFetchSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatementFetchSize</h4>
<pre>public&nbsp;void&nbsp;setStatementFetchSize(int&nbsp;size)</pre>
<div class="block">Sets statement's fetch size (0 for no default size)</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a name="getStatementFetchSize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStatementFetchSize</h4>
<pre>public&nbsp;int&nbsp;getStatementFetchSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>statement's fetch size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</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/ProcedureQuery.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/cayenne/query/ProcedureCall.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/ProcedureQuery.html" target="_top">Frames</a></li>
<li><a href="ProcedureQuery.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>