| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:27 CEST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractQuery (OpenJPA Parent POM 3.1.2 API)</title> |
| <meta name="date" content="2020-09-03"> |
| <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="AbstractQuery (OpenJPA Parent POM 3.1.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"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":6,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":6,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractQuery.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>Prev Class</li> |
| <li><a href="../../../../org/apache/openjpa/persistence/AnnotationBuilder.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/AbstractQuery.html" target="_top">Frames</a></li> |
| <li><a href="AbstractQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.persistence</div> |
| <h2 title="Class AbstractQuery" class="title">Class AbstractQuery<X></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.persistence.AbstractQuery<X></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>javax.persistence.Query, javax.persistence.TypedQuery<X>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><X>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuerySPI</a><X></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/persistence/QueryImpl.html" title="class in org.apache.openjpa.persistence">QueryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractQuery<X></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuerySPI</a><X></pre> |
| <div class="block">An abstract implementation of the Query interface.</div> |
| </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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><javax.persistence.Parameter<?>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_boundParams">_boundParams</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_convertPositionalParams">_convertPositionalParams</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,javax.persistence.Parameter<?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_declaredParams">_declaredParams</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/persistence/EntityManagerImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerImpl</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_em">_em</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_qmd">_qmd</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#Z:Z_relaxBindParameterTypeChecking">_relaxBindParameterTypeChecking</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.persistence.OpenJPAQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.persistence.<a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a></h3> |
| <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#HINT_RESULT_COUNT">HINT_RESULT_COUNT</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#OP_DELETE">OP_DELETE</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#OP_SELECT">OP_SELECT</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.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"> </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/persistence/AbstractQuery.html#AbstractQuery-org.apache.openjpa.meta.QueryMetaData-org.apache.openjpa.persistence.EntityManagerImpl-">AbstractQuery</a></span>(<a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a> qmd, |
| <a href="../../../../org/apache/openjpa/persistence/EntityManagerImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerImpl</a> em)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#assertOpen--">assertOpen</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#declareParameter-java.lang.Object-javax.persistence.Parameter-">declareParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key, |
| javax.persistence.Parameter<?> param)</code> |
| <div class="block">Declares the given parameter for this query.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getBoundParameterKeys--">getBoundParameterKeys</a></span>()</code> |
| <div class="block">Gets the parameter keys bound with this query.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getDeclaredParameterKeys--">getDeclaredParameterKeys</a></span>()</code> |
| <div class="block">Gets the declared parameter keys in the given query.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getDeclaredParameterKeys-java.lang.Class-">getDeclaredParameterKeys</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> keyType)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,javax.persistence.Parameter<?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getDeclaredParameters--">getDeclaredParameters</a></span>()</code> |
| <div class="block">Gets the parameter instances declared in this query.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getNamedParameters--">getNamedParameters</a></span>()</code> |
| <div class="block">Gets the value of all the named parameters.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>javax.persistence.Parameter<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameter-int-">getParameter</a></span>(int pos)</code> |
| <div class="block">Get the positional parameter with the given position.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><T> javax.persistence.Parameter<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameter-int-java.lang.Class-">getParameter</a></span>(int pos, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code> |
| <div class="block">Get the positional parameter with the given position and type.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>javax.persistence.Parameter<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameter-java.lang.String-">getParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Get the parameter object corresponding to the declared parameter of the given name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><T> javax.persistence.Parameter<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameter-java.lang.String-java.lang.Class-">getParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code> |
| <div class="block">Get the parameter of the given name and type.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><javax.persistence.Parameter<?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameters--">getParameters</a></span>()</code> |
| <div class="block">Gets the parameters declared in this query.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameterValue-int-">getParameterValue</a></span>(int pos)</code> |
| <div class="block">Return the value bound to the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameterValue-javax.persistence.Parameter-">getParameterValue</a></span>(javax.persistence.Parameter<T> p)</code> |
| <div class="block">Return the value bound to the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParameterValue-java.lang.String-">getParameterValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return the value bound to the parameter.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getParamTypes--">getParamTypes</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getPositionalParameters--">getPositionalParameters</a></span>()</code> |
| <div class="block">Gets the array of positional parameter values.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#getRelaxBindParameterTypeChecking--">getRelaxBindParameterTypeChecking</a></span>()</code> |
| <div class="block">Gets whether the type of user-supplied bind parameter value and the type of target persistent |
| property they bind to are checked with strong or weak constraint.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#hasPositionalParameters--">hasPositionalParameters</a></span>()</code> |
| <div class="block">Affirms if declared parameters use position identifier.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#isBound-javax.persistence.Parameter-">isBound</a></span>(javax.persistence.Parameter<?> param)</code> |
| <div class="block">Affirms if the given parameter is bound to a value for this query.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#isNative--">isNative</a></span>()</code> </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/openjpa/persistence/AbstractQuery.html#isProcedure--">isProcedure</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#lock--">lock</a></span>()</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-int-java.util.Calendar-javax.persistence.TemporalType-">setParameter</a></span>(int position, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> value, |
| javax.persistence.TemporalType t)</code> |
| <div class="block">Sets the value of the given positional parameter after conversion of the given value to the given Temporal Type.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-int-java.util.Date-javax.persistence.TemporalType-">setParameter</a></span>(int position, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> value, |
| javax.persistence.TemporalType type)</code> |
| <div class="block">Sets the value of the given named parameter after conversion of the given value to the given Temporal Type.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-int-java.lang.Object-">setParameter</a></span>(int pos, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Binds the parameter identified by the given position to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-javax.persistence.Parameter-java.util.Calendar-javax.persistence.TemporalType-">setParameter</a></span>(javax.persistence.Parameter<<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a>> p, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> cal, |
| javax.persistence.TemporalType type)</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-javax.persistence.Parameter-java.util.Date-javax.persistence.TemporalType-">setParameter</a></span>(javax.persistence.Parameter<<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>> p, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, |
| javax.persistence.TemporalType type)</code> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-javax.persistence.Parameter-T-">setParameter</a></span>(javax.persistence.Parameter<T> p, |
| T arg1)</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-java.lang.String-java.util.Calendar-javax.persistence.TemporalType-">setParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> value, |
| javax.persistence.TemporalType type)</code> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-java.lang.String-java.util.Date-javax.persistence.TemporalType-">setParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> value, |
| javax.persistence.TemporalType type)</code> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameter-java.lang.String-java.lang.Object-">setParameter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Sets the parameter of the given name to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameters-java.util.Map-">setParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</code> |
| <div class="block">Sets the values of the parameters from the given Map.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setParameters-java.lang.Object...-">setParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... params)</code> |
| <div class="block">Binds the given values as positional parameters.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#setRelaxBindParameterTypeChecking-java.lang.Object-">setRelaxBindParameterTypeChecking</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">Sets whether the type of user-supplied bind parameter value and the type of target persistent |
| property they bind to are checked with strong or weak constraint.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>protected abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html#unlock--">unlock</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.persistence.OpenJPAQuerySPI"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.persistence.<a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuerySPI</a></h3> |
| <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html#addAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">addAggregateListener</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html#addFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">addFilterListener</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html#removeAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">removeAggregateListener</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuerySPI.html#removeFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">removeFilterListener</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.persistence.OpenJPAQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.persistence.<a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a></h3> |
| <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#closeAll--">closeAll</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#compile--">compile</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getCandidateCollection--">getCandidateCollection</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getDataStoreActions-java.util.Map-">getDataStoreActions</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getEntityManager--">getEntityManager</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getFetchPlan--">getFetchPlan</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getFirstResult--">getFirstResult</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getFlushMode--">getFlushMode</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getIgnoreChanges--">getIgnoreChanges</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getLanguage--">getLanguage</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getMaxResults--">getMaxResults</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getOperation--">getOperation</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getQueryString--">getQueryString</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getResultClass--">getResultClass</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getSupportedHints--">getSupportedHints</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#hasSubclasses--">hasSubclasses</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setCandidateCollection-java.util.Collection-">setCandidateCollection</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setFirstResult-int-">setFirstResult</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setFlushMode-javax.persistence.FlushModeType-">setFlushMode</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setHint-java.lang.String-java.lang.Object-">setHint</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setIgnoreChanges-boolean-">setIgnoreChanges</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setMaxResults-int-">setMaxResults</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setResultClass-java.lang.Class-">setResultClass</a>, <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setSubclasses-boolean-">setSubclasses</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.persistence.TypedQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.persistence.TypedQuery</h3> |
| <code>getResultList, getResultStream, getSingleResult, setLockMode</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.persistence.Query"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.persistence.Query</h3> |
| <code>executeUpdate, getHints, getLockMode, unwrap</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="Z:Z_relaxBindParameterTypeChecking"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_relaxBindParameterTypeChecking</h4> |
| <pre>protected boolean _relaxBindParameterTypeChecking</pre> |
| </li> |
| </ul> |
| <a name="Z:Z_convertPositionalParams"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_convertPositionalParams</h4> |
| <pre>protected boolean _convertPositionalParams</pre> |
| </li> |
| </ul> |
| <a name="Z:Z_qmd"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_qmd</h4> |
| <pre>protected final <a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a> _qmd</pre> |
| </li> |
| </ul> |
| <a name="Z:Z_em"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_em</h4> |
| <pre>protected transient <a href="../../../../org/apache/openjpa/persistence/EntityManagerImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerImpl</a> _em</pre> |
| </li> |
| </ul> |
| <a name="Z:Z_boundParams"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_boundParams</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><javax.persistence.Parameter<?>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> _boundParams</pre> |
| </li> |
| </ul> |
| <a name="Z:Z_declaredParams"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>_declaredParams</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,javax.persistence.Parameter<?>> _declaredParams</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractQuery-org.apache.openjpa.meta.QueryMetaData-org.apache.openjpa.persistence.EntityManagerImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractQuery</h4> |
| <pre>public AbstractQuery(<a href="../../../../org/apache/openjpa/meta/QueryMetaData.html" title="class in org.apache.openjpa.meta">QueryMetaData</a> qmd, |
| <a href="../../../../org/apache/openjpa/persistence/EntityManagerImpl.html" title="class in org.apache.openjpa.persistence">EntityManagerImpl</a> em)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isProcedure--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isProcedure</h4> |
| <pre>public boolean isProcedure()</pre> |
| </li> |
| </ul> |
| <a name="isNative--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNative</h4> |
| <pre>public boolean isNative()</pre> |
| </li> |
| </ul> |
| <a name="assertOpen--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertOpen</h4> |
| <pre>protected abstract void assertOpen()</pre> |
| </li> |
| </ul> |
| <a name="lock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre>protected abstract void lock()</pre> |
| </li> |
| </ul> |
| <a name="unlock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre>protected abstract void unlock()</pre> |
| </li> |
| </ul> |
| <a name="getParamTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParamTypes</h4> |
| <pre>protected abstract <a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> getParamTypes()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map of parameter name to type for this query.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-int-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(int pos, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Binds the parameter identified by the given position to the given value. The parameter are bound to a value in |
| the context of this query. The same parameter may be bound to a different value in the context of another |
| query. <br> |
| For non-native queries, the given position must be a valid position in the declared parameters. <br> |
| As native queries may not be parsed and hence their declared parameters may not be known, setting an positional |
| parameter has the side-effect of a positional parameter being declared.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-int-java.lang.Object-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>position</code> - positive, integer position of the parameter</dd> |
| <dd><code>value</code> - an assignment compatible value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the same query instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if position does not correspond to a positional parameter of the query or if the argument is of |
| incorrect type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-int-java.util.Calendar-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(int position, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> value, |
| javax.persistence.TemporalType t)</pre> |
| <div class="block">Sets the value of the given positional parameter after conversion of the given value to the given Temporal Type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-int-java.util.Calendar-javax.persistence.TemporalType-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-int-java.util.Date-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(int position, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> value, |
| javax.persistence.TemporalType type)</pre> |
| <div class="block">Sets the value of the given named parameter after conversion of the given value to the given Temporal Type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-int-java.util.Date-javax.persistence.TemporalType-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasPositionalParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPositionalParameters</h4> |
| <pre>public boolean hasPositionalParameters()</pre> |
| <div class="block">Affirms if declared parameters use position identifier.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#hasPositionalParameters--">hasPositionalParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPositionalParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPositionalParameters</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] getPositionalParameters()</pre> |
| <div class="block">Gets the array of positional parameter values. The n-th array element represents (n+1)-th positional parameter. |
| If a parameter has been declared but not bound to a value then the value is null and hence is indistinguishable |
| from the value being actually null. If the parameter indexing is not contiguous then the unspecified parameters |
| are considered as null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getPositionalParameters--">getPositionalParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameters-java.lang.Object...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameters</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>... params)</pre> |
| <div class="block">Binds the given values as positional parameters. The n-th array element value is set to a Parameter with (n+1)-th |
| positional identifier.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameters-java.lang.Object...-">setParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamedParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamedParameters</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getNamedParameters()</pre> |
| <div class="block">Gets the value of all the named parameters. |
| |
| If a parameter has been declared but not bound to a value then the value is null and hence is indistinguishable |
| from the value being actually null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getNamedParameters--">getNamedParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameters</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</pre> |
| <div class="block">Sets the values of the parameters from the given Map. The keys of the given map designate the name of the |
| declared parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameters-java.util.Map-">setParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameter-java.lang.String-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameter</h4> |
| <pre>public <T> javax.persistence.Parameter<T> getParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</pre> |
| <div class="block">Get the parameter of the given name and type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameter of the specified name does not exist or is not assignable to the type</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if invoked on a native query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameter-int-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameter</h4> |
| <pre>public <T> javax.persistence.Parameter<T> getParameter(int pos, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</pre> |
| <div class="block">Get the positional parameter with the given position and type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameter with the specified position does not exist or is not assignable to the type</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if invoked on a native query unless the same parameter position is bound already.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterValue-javax.persistence.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterValue</h4> |
| <pre>public <T> T getParameterValue(javax.persistence.Parameter<T> p)</pre> |
| <div class="block">Return the value bound to the parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameterValue</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>param</code> - parameter object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parameter value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the parameter has not been been bound</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameter does not belong to this query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameters</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><javax.persistence.Parameter<?>> getParameters()</pre> |
| <div class="block">Gets the parameters declared in this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameters</code> in interface <code>javax.persistence.Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-javax.persistence.Parameter-java.lang.Object-"> |
| <!-- --> |
| </a><a name="setParameter-javax.persistence.Parameter-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <T> <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(javax.persistence.Parameter<T> p, |
| T arg1)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-javax.persistence.Parameter-java.util.Date-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(javax.persistence.Parameter<<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>> p, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, |
| javax.persistence.TemporalType type)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-javax.persistence.Parameter-java.util.Calendar-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(javax.persistence.Parameter<<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a>> p, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> cal, |
| javax.persistence.TemporalType type)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameter</h4> |
| <pre>public javax.persistence.Parameter<?> getParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Get the parameter object corresponding to the declared parameter of the given name. This method is not required |
| to be supported for native queries.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameter of the specified name does not exist</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if invoked on a native query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameter-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameter</h4> |
| <pre>public javax.persistence.Parameter<?> getParameter(int pos)</pre> |
| <div class="block">Get the positional parameter with the given position. The parameter may just have been declared and not bound to |
| a value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>position</code> - specified in the user query.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parameter object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the parameter with the given position does not exist</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterValue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterValue</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getParameterValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Return the value bound to the parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameterValue</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the parameter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parameter value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if this parameter has not been bound</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterValue-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterValue</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getParameterValue(int pos)</pre> |
| <div class="block">Return the value bound to the parameter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getParameterValue</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pos</code> - position of the parameter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>parameter value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if this parameter has not been bound</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBoundParameterKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoundParameterKeys</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?> getBoundParameterKeys()</pre> |
| <div class="block">Gets the parameter keys bound with this query. Parameter key can be Integer, String or a ParameterExpression |
| itself but all parameters keys of a particular query are of the same type.</div> |
| </li> |
| </ul> |
| <a name="getDeclaredParameterKeys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredParameterKeys</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?> getDeclaredParameterKeys()</pre> |
| <div class="block">Gets the declared parameter keys in the given query. This information is only available after the query has been |
| parsed. As native language queries are not parsed, this information is not available for them.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>set of parameter identifiers in a parsed query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredParameterKeys-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredParameterKeys</h4> |
| <pre>public <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><T> getDeclaredParameterKeys(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> keyType)</pre> |
| </li> |
| </ul> |
| <a name="getDeclaredParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredParameters</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,javax.persistence.Parameter<?>> getDeclaredParameters()</pre> |
| <div class="block">Gets the parameter instances declared in this query. All parameter keys are of the same type. It is not allowed |
| to mix keys of different type such as named and positional keys. |
| |
| For string-based queries, the parser supplies the information about the declared parameters as a LinkedMap of |
| expected parameter value type indexed by parameter identifier. For non string-based queries that a facade itself |
| may construct (e.g. CriteriaQuery), the parameters must be declared by the caller. This receiver constructs |
| concrete Parameter instances from the given parameter identifiers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Map where the key represents the original identifier of the parameter (can be a String, Integer or a |
| ParameterExpression itself) and the value is the concrete Parameter instance either constructed as a |
| result of this call or supplied by declaring the parameter explicitly via |
| #declareParameter(Parameter).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="declareParameter-java.lang.Object-javax.persistence.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareParameter</h4> |
| <pre>public void declareParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key, |
| javax.persistence.Parameter<?> param)</pre> |
| <div class="block">Declares the given parameter for this query. Used by non-string based queries that are constructed by the facade |
| itself rather than OpenJPA parsing the query to detect the declared parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - this is the key to identify the parameter later in the context of this query. Valid key types are |
| Integer, String or ParameterExpression itself.</dd> |
| <dd><code>the</code> - parameter instance to be declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBound-javax.persistence.Parameter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBound</h4> |
| <pre>public boolean isBound(javax.persistence.Parameter<?> param)</pre> |
| <div class="block">Affirms if the given parameter is bound to a value for this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isBound</code> in interface <code>javax.persistence.Query</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-java.lang.String-java.util.Calendar-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> value, |
| javax.persistence.TemporalType type)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-java.lang.String-java.util.Calendar-javax.persistence.TemporalType-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-java.lang.String-java.util.Date-javax.persistence.TemporalType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> value, |
| javax.persistence.TemporalType type)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-java.lang.String-java.util.Date-javax.persistence.TemporalType-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setParameter-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameter</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>> setParameter(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">Sets the parameter of the given name to the given value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.Query</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setParameter</code> in interface <code>javax.persistence.TypedQuery<<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setParameter-java.lang.String-java.lang.Object-">setParameter</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRelaxBindParameterTypeChecking--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelaxBindParameterTypeChecking</h4> |
| <pre>public boolean getRelaxBindParameterTypeChecking()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getRelaxBindParameterTypeChecking--">OpenJPAQuery</a></code></span></div> |
| <div class="block">Gets whether the type of user-supplied bind parameter value and the type of target persistent |
| property they bind to are checked with strong or weak constraint.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#getRelaxBindParameterTypeChecking--">getRelaxBindParameterTypeChecking</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the booelan state. False by default, i.e. the type of a bind parameter value is checked |
| strongly against the target property type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRelaxBindParameterTypeChecking-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setRelaxBindParameterTypeChecking</h4> |
| <pre>public void setRelaxBindParameterTypeChecking(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setRelaxBindParameterTypeChecking-java.lang.Object-">OpenJPAQuery</a></code></span></div> |
| <div class="block">Sets whether the type of user-supplied bind parameter value and the type of target persistent |
| property they bind to are checked with strong or weak constraint. |
| <br> |
| The same can be set via <code>hint</code> without puncturing standard |
| JPA API.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html#setRelaxBindParameterTypeChecking-java.lang.Object-">setRelaxBindParameterTypeChecking</a></code> in interface <code><a href="../../../../org/apache/openjpa/persistence/OpenJPAQuery.html" title="interface in org.apache.openjpa.persistence">OpenJPAQuery</a><<a href="../../../../org/apache/openjpa/persistence/AbstractQuery.html" title="type parameter in AbstractQuery">X</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a String or Boolean value.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/Filters.html#canConvert-java.lang.Class-java.lang.Class-boolean-"><code>Filters.canConvert(Class, Class, boolean)</code></a>, |
| <a href="../../../../org/apache/openjpa/kernel/Filters.html#convert-java.lang.Object-java.lang.Class-boolean-"><code>Filters.convert(Object, Class, boolean)</code></a></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/AbstractQuery.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>Prev Class</li> |
| <li><a href="../../../../org/apache/openjpa/persistence/AnnotationBuilder.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/persistence/AbstractQuery.html" target="_top">Frames</a></li> |
| <li><a href="AbstractQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2006–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
