| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:07 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DatabaseQuery (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DatabaseQuery (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| 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,"i33":6,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":10,"i147":10,"i148":10,"i149":10,"i150":10,"i151":10,"i152":10,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":10,"i159":10,"i160":10,"i161":10,"i162":10,"i163":10,"i164":10,"i165":10,"i166":10,"i167":10,"i168":10,"i169":10,"i170":10,"i171":10,"i172":10,"i173":10,"i174":10,"i175":10,"i176":10,"i177":10,"i178":10,"i179":10,"i180":10,"i181":10,"i182":10,"i183":10,"i184":10,"i185":10,"i186":10,"i187":10,"i188":10,"i189":10,"i190":10,"i191":10,"i192":10,"i193":10,"i194":10,"i195":10,"i196":10,"i197":10,"i198":10,"i199":10,"i200":10,"i201":10,"i202":10,"i203":10,"i204":10,"i205":10,"i206":10,"i207":10,"i208":10,"i209":10,"i210":10,"i211":10,"i212":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/queries/DatabaseQuery.html" target="_top">Frames</a></li> |
| <li><a href="DatabaseQuery.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><a href="#nested.class.summary">Nested</a> | </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.eclipse.persistence.queries</div> |
| <h2 title="Class DatabaseQuery" class="title">Class DatabaseQuery</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.eclipse.persistence.queries.DatabaseQuery</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DoesExistQuery.html" title="class in org.eclipse.persistence.queries">DoesExistQuery</a>, <a href="../../../../org/eclipse/persistence/queries/ModifyQuery.html" title="class in org.eclipse.persistence.queries">ModifyQuery</a>, <a href="../../../../org/eclipse/persistence/queries/ReadQuery.html" title="class in org.eclipse.persistence.queries">ReadQuery</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">DatabaseQuery</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: Abstract class for all database query objects. DatabaseQuery |
| is a visible class to the EclipseLink user. Users create an appropriate query |
| by creating an instance of a concrete subclasses of DatabaseQuery. |
| |
| <p> |
| <b>Responsibilities</b>: |
| <ul> |
| <li>Provide a common protocol for query objects. |
| <li>Defines a generic execution interface. |
| <li>Provides query property values |
| <li>Holds arguments to the query |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.eclipse.persistence.queries.DatabaseQuery">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Yvon Lavoie</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TOPLink/Java 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a></span></code> |
| <div class="block">Used for parameter retreival in JPQL</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </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/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#accessors">accessors</a></span></code> |
| <div class="block">Connection to use for database access, required for server session |
| connection pooling.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#allowNativeSQLQuery">allowNativeSQLQuery</a></span></code> |
| <div class="block">Property used to override a persistence unit level that disallows native |
| SQL queries.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentFields">argumentFields</a></span></code> |
| <div class="block">PERF: Argument fields are cached in prepare to avoid rebuilding on each |
| execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentParameterTypes">argumentParameterTypes</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/List.html?is-external=true" title="class or interface in java.util">List</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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#arguments">arguments</a></span></code> |
| <div class="block">Arguments can be given and specified to predefined queries to allow |
| reuse.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentTypeNames">argumentTypeNames</a></span></code> |
| <div class="block">Used to build a list of argumentTypes by name pre-initialization</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/eclipse/persistence/queries/DatabaseQuery.html#argumentTypes">argumentTypes</a></span></code> |
| <div class="block">Needed to differentiate queries with the same name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#argumentValues">argumentValues</a></span></code> |
| <div class="block">Arguments values can be given and specified to predefined queries to |
| allow reuse.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#BATCH_FETCH_PROPERTY">BATCH_FETCH_PROPERTY</a></span></code> |
| <div class="block">INTERNAL: Property used for batch fetching in non object queries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeAggregateDelete">CascadeAggregateDelete</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeAllParts">CascadeAllParts</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeByMapping">CascadeByMapping</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadeDependentParts">CascadeDependentParts</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadePolicy">cascadePolicy</a></span></code> |
| <div class="block">Policy that determines how the query will cascade to its object's parts.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#CascadePrivateParts">CascadePrivateParts</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#descriptor">descriptor</a></span></code> |
| <div class="block">The descriptor cached on the prepare for object level queries.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#descriptors">descriptors</a></span></code> |
| <div class="block">The list of descriptors this query deals with.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#doNotRedirect">doNotRedirect</a></span></code> |
| <div class="block">Can be set to true in the case there is a redirector or a default |
| redirector but the user does not want the query redirected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executionSession">executionSession</a></span></code> |
| <div class="block">Only used after the query is cloned for execution to store the execution |
| session under which the query was executed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#flushOnExecute">flushOnExecute</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hintString">hintString</a></span></code> |
| <div class="block">Used for adding hints to the query string in oracle</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomQueryUsed">isCustomQueryUsed</a></span></code> |
| <div class="block">PERF: Store if this query will use the descriptor custom query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExecutionClone">isExecutionClone</a></span></code> |
| <div class="block">PERF: Determines if the query has already been cloned for execution, to |
| avoid duplicate cloning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isNativeConnectionRequired">isNativeConnectionRequired</a></span></code> |
| <div class="block">Allow connection unwrapping to be configured.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isPrepared">isPrepared</a></span></code> |
| <div class="block">Queries prepare common stated in themselves.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefined">isUserDefined</a></span></code> |
| <div class="block">Internal flag used to bypass user define queries when executing one for |
| custom sql/query support.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefinedSQLCall">isUserDefinedSQLCall</a></span></code> |
| <div class="block">Internal flag used to bypass user define queries when executing one for |
| custom sql/query support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#monitorName">monitorName</a></span></code> |
| <div class="block">Return the name to use for the query in performance monitoring.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#name">name</a></span></code> |
| <div class="block">Queries can be given a name and registered with a descriptor to allow |
| common queries to be reused.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#NoCascading">NoCascading</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/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#nullableArguments">nullableArguments</a></span></code> |
| <div class="block">List of arguments to check for null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#parameterDelimiter">parameterDelimiter</a></span></code> |
| <div class="block">Allow the reserved pound char used to delimit bind parameters to be overridden</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#partitioningPolicy">partitioningPolicy</a></span></code> |
| <div class="block">Allow queries to be targeted at specific connection pools.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#properties">properties</a></span></code> |
| <div class="block">Internally used by the mappings as a temporary store.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.queries.DatabaseQueryMechanism</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryMechanism">queryMechanism</a></span></code> |
| <div class="block">The query mechanism determines the mechanism on how the database will be |
| accessed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryTimeout">queryTimeout</a></span></code> |
| <div class="block">queryTimeout has three possible settings: DefaultTimeout, NoTimeout, and |
| 1..N This applies to both DatabaseQuery.queryTimeout and |
| DescriptorQueryManager.queryTimeout |
| |
| DatabaseQuery.queryTimeout: - DefaultTimeout: get queryTimeout from |
| DescriptorQueryManager - NoTimeout, 1..N: overrides queryTimeout in |
| DescriptorQueryManager |
| |
| DescriptorQueryManager.queryTimeout: - DefaultTimeout: get queryTimeout |
| from parent DescriptorQueryManager.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#queryTimeoutUnit">queryTimeoutUnit</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#redirector">redirector</a></span></code> |
| <div class="block">A redirector allows for a queries execution to be the execution of a |
| piece of code.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#session">session</a></span></code> |
| <div class="block">Only used after the query is cloned for execution to store the session |
| under which the query was executed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#sessionName">sessionName</a></span></code> |
| <div class="block">Used to override the default session in the session broker.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldBindAllParameters">shouldBindAllParameters</a></span></code> |
| <div class="block">Bind all arguments to the SQL statement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCacheStatement">shouldCacheStatement</a></span></code> |
| <div class="block">Cache the prepared statement, this requires full parameter binding as |
| well.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCloneCall">shouldCloneCall</a></span></code> |
| <div class="block">Used to indicate whether or not the call needs to be cloned.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldMaintainCache">shouldMaintainCache</a></span></code> |
| <div class="block">Flag used for a query to bypass the identitymap and unit of work.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare">shouldPrepare</a></span></code> |
| <div class="block">Allow for the prepare of queries to be turned off, this allow for dynamic |
| non-pre SQL generated queries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldRetrieveBypassCache">shouldRetrieveBypassCache</a></span></code> |
| <div class="block">JPA flags to control the shared cache</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldStoreBypassCache">shouldStoreBypassCache</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/eclipse/persistence/queries/DatabaseQuery.html#shouldUseWrapperPolicy">shouldUseWrapperPolicy</a></span></code> |
| <div class="block">Use the WrapperPolicy for the objects returned by the query</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldValidateUpdateCallCacheUse">shouldValidateUpdateCallCacheUse</a></span></code> |
| <div class="block">Allow additional validation to be performed before using the update call cache</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#sourceMapping">sourceMapping</a></span></code> |
| <div class="block">Table per class requires multiple query executions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractRecord</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#translationRow">translationRow</a></span></code> |
| <div class="block">Mappings and the descriptor use parameterized mechanisms that will be |
| translated with the data from the row.</div> |
| </td> |
| </tr> |
| </table> |
| </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/eclipse/persistence/queries/DatabaseQuery.html#DatabaseQuery--">DatabaseQuery</a></span>()</code> |
| <div class="block">PUBLIC: Initialize the state of the query</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-">addArgument</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> argumentName)</code> |
| <div class="block">PUBLIC: Add the argument named argumentName.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-">addArgument</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> argumentName, |
| <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> type)</code> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type.</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/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-boolean-">addArgument</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> argumentName, |
| <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> type, |
| boolean nullable)</code> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-">addArgument</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> argumentName, |
| <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> type, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a> parameterType)</code> |
| <div class="block">INTERNAL: Add the argument named argumentName.</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/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-boolean-">addArgument</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> argumentName, |
| <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> type, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a> argumentParameterType, |
| boolean nullable)</code> |
| <div class="block">INTERNAL: Add the argument named argumentName.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgument-java.lang.String-java.lang.String-">addArgument</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> argumentName, |
| <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> typeAsString)</code> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgumentByTypeName-java.lang.String-java.lang.String-">addArgumentByTypeName</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> argumentName, |
| <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> typeAsString)</code> |
| <div class="block">INTERNAL: Add an argument to the query, but do not resolve the class yet.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addArgumentValue-java.lang.Object-">addArgumentValue</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> argumentValue)</code> |
| <div class="block">PUBLIC: Add the argumentValue.</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/eclipse/persistence/queries/DatabaseQuery.html#addArgumentValues-java.util.List-">addArgumentValues</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> theArgumentValues)</code> |
| <div class="block">PUBLIC: Add the argumentValues to the query.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addCall-org.eclipse.persistence.queries.Call-">addCall</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</code> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#addStatement-org.eclipse.persistence.internal.expressions.SQLStatement-">addStatement</a></span>(org.eclipse.persistence.internal.expressions.SQLStatement statement)</code> |
| <div class="block">PUBLIC: Used to define a statement level query.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#bindAllParameters--">bindAllParameters</a></span>()</code> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#buildArgumentFields--">buildArgumentFields</a></span>()</code> |
| <div class="block">INTERNAL: Build the list of arguments fields from the argument names and |
| types.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#buildSelectionCriteria-org.eclipse.persistence.internal.sessions.AbstractSession-">buildSelectionCriteria</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: In the case of EJBQL, an expression needs to be generated.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cacheStatement--">cacheStatement</a></span>()</code> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeAllParts--">cascadeAllParts</a></span>()</code> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all objects related to the queries object(s).</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeByMapping--">cascadeByMapping</a></span>()</code> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all related objects where the mapping has been set to cascade the merge.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadeOnlyDependentParts--">cascadeOnlyDependentParts</a></span>()</code> |
| <div class="block">INTERNAL: Used by unit of work, only cascades constraint dependencies.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#cascadePrivateParts--">cascadePrivateParts</a></span>()</code> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all privately owned objects related to the queries object(s).</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-">checkDescriptor</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: Ensure that the descriptor has been set.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkEarlyReturn-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkEarlyReturn</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Check to see if this query already knows the return value |
| without performing any further work.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkForCustomQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkForCustomQuery</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Check to see if a custom query should be used for this query.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">checkPrepare</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Check to see if this query needs to be prepare and prepare it.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-boolean-">checkPrepare</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, |
| boolean force)</code> |
| <div class="block">INTERNAL: Check to see if this query needs to be prepare and prepare it.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#clone--">clone</a></span>()</code> |
| <div class="block">INTERNAL: Clone the query</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#clonedQueryExecutionComplete-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">clonedQueryExecutionComplete</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL Used to give the subclasses opportunity to copy aspects of the |
| cloned query to the original query.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">INTERNAL: Convert all the class-name-based settings in this query to |
| actual class-based settings This method is implemented by subclasses as |
| necessary.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#copyFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">copyFromQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query)</code> |
| <div class="block">INTERNAL: Copy all setting from the query.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontBindAllParameters--">dontBindAllParameters</a></span>()</code> |
| <div class="block">PUBLIC: Do not Bind all arguments to any SQL statement.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontCacheStatement--">dontCacheStatement</a></span>()</code> |
| <div class="block">PUBLIC: Don't cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#dontCascadeParts--">dontCascadeParts</a></span>()</code> |
| <div class="block">PUBLIC: Do not cascade the query and its properties on the queries |
| object(s) relationships.</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/eclipse/persistence/queries/DatabaseQuery.html#dontMaintainCache--">dontMaintainCache</a></span>()</code> |
| <div class="block">PUBLIC: Set for the identity map (cache) to be ignored completely.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#execute-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">execute</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Execute the query.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executeDatabaseQuery--">executeDatabaseQuery</a></span>()</code> |
| <div class="block">INTERNAL: Execute the query</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#executeInUnitOfWork-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractRecord-">executeInUnitOfWork</a></span>(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Override query execution where Session is a UnitOfWork.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#extractRemoteResult-org.eclipse.persistence.internal.sessions.remote.Transporter-">extractRemoteResult</a></span>(org.eclipse.persistence.internal.sessions.remote.Transporter transporter)</code> |
| <div class="block">INTERNAL: Extract the correct query result from the transporter.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.databaseaccess.Accessor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getAccessor--">getAccessor</a></span>()</code> |
| <div class="block">INTERNAL: Return the accessor.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getAccessors--">getAccessors</a></span>()</code> |
| <div class="block">INTERNAL: Return the accessors.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentParameterTypes--">getArgumentParameterTypes</a></span>()</code> |
| <div class="block">INTERNAL: |
| Used to calculate parameter types in JPQL</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArguments--">getArguments</a></span>()</code> |
| <div class="block">INTERNAL: Return the arguments for use with the pre-defined query option</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentTypeNames--">getArgumentTypeNames</a></span>()</code> |
| <div class="block">INTERNAL: Return the argumentTypeNames for use with the pre-defined query |
| option These are used pre-initialization to construct the argumentTypes |
| list.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/eclipse/persistence/queries/DatabaseQuery.html#getArgumentTypes--">getArgumentTypes</a></span>()</code> |
| <div class="block">INTERNAL: Return the argumentTypes for use with the pre-defined query |
| option</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getArgumentValues--">getArgumentValues</a></span>()</code> |
| <div class="block">INTERNAL: Return the argumentValues for use with argumented queries.</div> |
| </td> |
| </tr> |
| <tr id="i43" 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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getBatchObjects--">getBatchObjects</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return temporary map of batched objects.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.databaseaccess.DatabaseCall</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getCall--">getCall</a></span>()</code> |
| <div class="block">OBSOLETE: Return the call for this query.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getCascadePolicy--">getCascadePolicy</a></span>()</code> |
| <div class="block">INTERNAL: Return the cascade policy.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDatasourceCall--">getDatasourceCall</a></span>()</code> |
| <div class="block">ADVANCED: Return the call for this query.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDatasourceCalls--">getDatasourceCalls</a></span>()</code> |
| <div class="block">ADVANCED: Return the calls for this query.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDefaultRedirector--">getDefaultRedirector</a></span>()</code> |
| <div class="block">INTERNAL: Returns the specific default redirector for this query type.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDescriptor--">getDescriptor</a></span>()</code> |
| <div class="block">INTERNAL: Return the descriptor assigned with the reference class</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDescriptors--">getDescriptors</a></span>()</code> |
| <div class="block">INTERNAL: |
| This is here only for JPA queries and currently only populated for JPA |
| queries.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDomainClassNounName-java.lang.String-">getDomainClassNounName</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> sessionName)</code> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDoNotRedirect--">getDoNotRedirect</a></span>()</code> |
| <div class="block">This method is used in combination with redirected queries.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getEJBQLString--">getEJBQLString</a></span>()</code> |
| <div class="block">PUBLIC: Return the EJBQL string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getExecutionSession--">getExecutionSession</a></span>()</code> |
| <div class="block">INTERNAL: Return the execution session.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getFlushOnExecute--">getFlushOnExecute</a></span>()</code> |
| <div class="block">PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute |
| is true EclipseLink will write changes to the database before executing |
| the query.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getHintString--">getHintString</a></span>()</code> |
| <div class="block">PUBLIC: Return the current database hint string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getJPQLString--">getJPQLString</a></span>()</code> |
| <div class="block">PUBLIC: Return the JPQL string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getMonitorName--">getMonitorName</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the name to use for the query in performance monitoring.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getName--">getName</a></span>()</code> |
| <div class="block">PUBLIC: Return the name of the query</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getNullableArguments--">getNullableArguments</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the list of arguments to check for null.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getParameterDelimiter--">getParameterDelimiter</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the String used to delimit an SQL parameter.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getParameterDelimiterChar--">getParameterDelimiterChar</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the char used to delimit an SQL parameter.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getPartitioningPolicy--">getPartitioningPolicy</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the query's partitioning policy.</div> |
| </td> |
| </tr> |
| <tr id="i64" 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/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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">INTERNAL: Property support for use by mappings.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getProperty-java.lang.Object-">getProperty</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> property)</code> |
| <div class="block">INTERNAL: Property support used by mappings to store temporary stuff in |
| the query.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.queries.DatabaseQueryMechanism</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryMechanism--">getQueryMechanism</a></span>()</code> |
| <div class="block">INTERNAL: Return the mechanism assigned to the query</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryNounName-java.lang.String-">getQueryNounName</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> sessionName)</code> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass_queryClass_queryName (if exist).</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryTimeout--">getQueryTimeout</a></span>()</code> |
| <div class="block">PUBLIC: Return the number of seconds the driver will wait for a Statement |
| to execute to the given number of seconds.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getQueryTimeoutUnit--">getQueryTimeoutUnit</a></span>()</code> |
| <div class="block">PUBLIC: Return the unit of time the driver will wait for a Statement to |
| execute.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getRedirector--">getRedirector</a></span>()</code> |
| <div class="block">PUBLIC: Return the query redirector.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getRedirectorForQuery--">getRedirectorForQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return the query redirector.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code><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/eclipse/persistence/queries/DatabaseQuery.html#getReferenceClass--">getReferenceClass</a></span>()</code> |
| <div class="block">PUBLIC: Return the domain class associated with this query.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getReferenceClassName--">getReferenceClassName</a></span>()</code> |
| <div class="block">INTERNAL: return the name of the reference class.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSelectionCriteria--">getSelectionCriteria</a></span>()</code> |
| <div class="block">PUBLIC: Return the selection criteria of the query.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSensorName-java.lang.String-java.lang.String-">getSensorName</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> operationName, |
| <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> sessionName)</code> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass_queryClass_queryName (if exist)_operationName (if exist).</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSession--">getSession</a></span>()</code> |
| <div class="block">INTERNAL: Return the current session.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSessionName--">getSessionName</a></span>()</code> |
| <div class="block">PUBLIC: Return the name of the session that the query should be executed |
| under.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getShouldBindAllParameters--">getShouldBindAllParameters</a></span>()</code> |
| <div class="block">INTERNAL: Returns the internal tri-state value of shouldBindParameters |
| used far cascading these settings</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSourceMapping--">getSourceMapping</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.expressions.SQLStatement</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLStatement--">getSQLStatement</a></span>()</code> |
| <div class="block">PUBLIC: Return the SQL statement of the query.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLString--">getSQLString</a></span>()</code> |
| <div class="block">ADVANCED: Return the SQL string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLStrings--">getSQLStrings</a></span>()</code> |
| <div class="block">ADVANCED: Return the SQL strings of the query.</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslatedSQLString-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">getTranslatedSQLString</a></span>(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow)</code> |
| <div class="block">ADVANCED: This can be used to access a queries translated SQL if they |
| have been prepared, (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslatedSQLStrings-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">getTranslatedSQLStrings</a></span>(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow)</code> |
| <div class="block">ADVANCED: This can be used to access a queries translated SQL if they |
| have been prepared, (i.e.</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractRecord</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslationRow--">getTranslationRow</a></span>()</code> |
| <div class="block">INTERNAL: Return the row for translation</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasAccessor--">hasAccessor</a></span>()</code> |
| <div class="block">INTERNAL: returns true if the accessor has already been set.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasArguments--">hasArguments</a></span>()</code> |
| <div class="block">INTERNAL: Return if any arguments exist in the query.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasNullableArguments--">hasNullableArguments</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if the query has any nullable arguments.</div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasProperties--">hasProperties</a></span>()</code> |
| <div class="block">INTERNAL: Return if any properties exist in the query.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasQueryMechanism--">hasQueryMechanism</a></span>()</code> |
| <div class="block">INTERNAL: Check if the mechanism has been set yet, used for lazy init.</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#hasSessionName--">hasSessionName</a></span>()</code> |
| <div class="block">PUBLIC: Return if a name of the session that the query should be executed |
| under has been specified.</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#ignoreBindAllParameters--">ignoreBindAllParameters</a></span>()</code> |
| <div class="block">PUBLIC: Session's shouldBindAllParameters() defines whether to bind or |
| not (default setting)</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#ignoreCacheStatement--">ignoreCacheStatement</a></span>()</code> |
| <div class="block">PUBLIC: Session's shouldCacheAllStatements() defines whether to cache or |
| not (default setting)</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCallQuery--">isCallQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this query uses SQL, a stored procedure, or SDK |
| call.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCascadeOfAggregateDelete--">isCascadeOfAggregateDelete</a></span>()</code> |
| <div class="block">INTERNAL: Returns true if this query has been created as the result of |
| cascading a delete of an aggregate collection in a UnitOfWork CR 2811</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomQueryUsed--">isCustomQueryUsed</a></span>()</code> |
| <div class="block">INTERNAL: PERF: Return if this query will use the descriptor custom query |
| instead of executing itself.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isCustomSelectionQuery--">isCustomSelectionQuery</a></span>()</code> |
| <div class="block">INTERNAL: If the query mechanism is a call query mechanism and there are |
| no arguments on the query then it must be a foreign reference custom |
| selection query.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDataModifyQuery--">isDataModifyQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a data modify query.</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDataReadQuery--">isDataReadQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a data read query.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDefaultPropertiesQuery--">isDefaultPropertiesQuery</a></span>()</code> |
| <div class="block">INTERNAL: Return true if the query uses default properties.</div> |
| </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDeleteAllQuery--">isDeleteAllQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a delete all query.</div> |
| </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDeleteObjectQuery--">isDeleteObjectQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a delete object query.</div> |
| </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isDirectReadQuery--">isDirectReadQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a direct read query.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExecutionClone--">isExecutionClone</a></span>()</code> |
| <div class="block">INTERNAL: PERF: Return if the query is an execution clone.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isExpressionQuery--">isExpressionQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this query uses an expression query mechanism</div> |
| </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isInsertObjectQuery--">isInsertObjectQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is an insert object query.</div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isJPQLCallQuery--">isJPQLCallQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this query uses an JPQL query mechanism .</div> |
| </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isModifyAllQuery--">isModifyAllQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a modify all query.</div> |
| </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isModifyQuery--">isModifyQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a modify query.</div> |
| </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isNativeConnectionRequired--">isNativeConnectionRequired</a></span>()</code> |
| <div class="block">ADVANCED: Return if the descriptor requires usage of a native (unwrapped) |
| JDBC connection.</div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectBuildingQuery--">isObjectBuildingQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is an object building query.</div> |
| </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectLevelModifyQuery--">isObjectLevelModifyQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is an object level modify query.</div> |
| </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isObjectLevelReadQuery--">isObjectLevelReadQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is an object level read query.</div> |
| </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isPrepared--">isPrepared</a></span>()</code> |
| <div class="block">INTERNAL: Queries are prepared when they are executed and then do not |
| need to be prepared on subsequent executions.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadAllQuery--">isReadAllQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a read all query.</div> |
| </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadObjectQuery--">isReadObjectQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a read object query.</div> |
| </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReadQuery--">isReadQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a read query.</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isReportQuery--">isReportQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a report query.</div> |
| </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isResultSetMappingQuery--">isResultSetMappingQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a result set mapping query.</div> |
| </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isSQLCallQuery--">isSQLCallQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this query uses an SQL query mechanism .</div> |
| </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUpdateAllQuery--">isUpdateAllQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is an update all query.</div> |
| </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUpdateObjectQuery--">isUpdateObjectQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is an update object query.</div> |
| </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefined--">isUserDefined</a></span>()</code> |
| <div class="block">INTERNAL: Return true if the query is a custom user defined query.</div> |
| </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isUserDefinedSQLCall--">isUserDefinedSQLCall</a></span>()</code> |
| <div class="block">INTERNAL: Return true if the query is a custom user defined SQL call query.</div> |
| </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isValueReadQuery--">isValueReadQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return if this is a value read query.</div> |
| </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#isWriteObjectQuery--">isWriteObjectQuery</a></span>()</code> |
| <div class="block">PUBLIC: Return true if this is a write object query.</div> |
| </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#maintainCache--">maintainCache</a></span>()</code> |
| <div class="block">PUBLIC: Set for the identity map (cache) to be maintained.</div> |
| </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepare--">prepare</a></span>()</code> |
| <div class="block">INTERNAL: This is different from 'prepareForExecution' in that this is |
| called on the original query, and the other is called on the copy of the |
| query.</div> |
| </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-">prepareCall</a></span>(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow)</code> |
| <div class="block">ADVANCED: Pre-generate the call/SQL for the query.</div> |
| </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCustomQuery-org.eclipse.persistence.queries.DatabaseQuery-">prepareCustomQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> customQuery)</code> |
| <div class="block">INTERNAL: Set the properties needed to be cascaded into the custom query.</div> |
| </td> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareForExecution--">prepareForExecution</a></span>()</code> |
| <div class="block">INTERNAL: Prepare the receiver for execution in a session.</div> |
| </td> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareForRemoteExecution--">prepareForRemoteExecution</a></span>()</code> </td> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareFromQuery-org.eclipse.persistence.queries.DatabaseQuery-">prepareFromQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query)</code> |
| <div class="block">INTERNAL: Prepare the query from the prepared query.</div> |
| </td> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareInternal-org.eclipse.persistence.internal.sessions.AbstractSession-">prepareInternal</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: Call the prepare on the query.</div> |
| </td> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#redirectQuery-org.eclipse.persistence.queries.QueryRedirector-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-">redirectQuery</a></span>(<a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> redirector, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> queryToRedirect, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Use a EclipseLink redirector to redirect this query to a |
| method.</div> |
| </td> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#remoteExecute--">remoteExecute</a></span>()</code> </td> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#remoteExecute-org.eclipse.persistence.internal.sessions.AbstractSession-">remoteExecute</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#removeProperty-java.lang.Object-">removeProperty</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> property)</code> |
| <div class="block">INTERNAL: Property support used by mappings.</div> |
| </td> |
| </tr> |
| <tr id="i139" 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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">replaceValueHoldersIn</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> object, |
| org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)</code> |
| <div class="block">INTERNAL: replace the value holders in the specified result object(s)</div> |
| </td> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#resetMonitorName--">resetMonitorName</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the name to use for the query in performance monitoring.</div> |
| </td> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#retrieveBypassCache--">retrieveBypassCache</a></span>()</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractRecord</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#rowFromArguments-java.util.List-org.eclipse.persistence.internal.sessions.AbstractSession-">rowFromArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> argumentValues, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: Translate argumentValues into a database row.</div> |
| </td> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAccessor-org.eclipse.persistence.internal.databaseaccess.Accessor-">setAccessor</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)</code> |
| <div class="block">INTERNAL: Set the accessor, the query must always use the same accessor |
| for database access.</div> |
| </td> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAccessors-java.util.Collection-">setAccessors</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor> accessors)</code> |
| <div class="block">INTERNAL: |
| Set the list of connection accessors to execute the query on.</div> |
| </td> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setAllowNativeSQLQuery-java.lang.Boolean-">setAllowNativeSQLQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> allowNativeSQLQuery)</code> |
| <div class="block">INTERNAL: |
| Set to true if this individual query should be marked to bypass a |
| persistence unit level disallow SQL queries flag.</div> |
| </td> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArguments-java.util.List-">setArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> arguments)</code> |
| <div class="block">INTERNAL: Set the arguments for use with the pre-defined query option.</div> |
| </td> |
| </tr> |
| <tr id="i147" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentTypeNames-java.util.List-">setArgumentTypeNames</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypeNames)</code> |
| <div class="block">INTERNAL: Set the argumentTypes for use with the pre-defined query option</div> |
| </td> |
| </tr> |
| <tr id="i148" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentTypes-java.util.List-">setArgumentTypes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypes)</code> |
| <div class="block">INTERNAL: Set the argumentTypes for use with the pre-defined query option</div> |
| </td> |
| </tr> |
| <tr id="i149" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setArgumentValues-java.util.List-">setArgumentValues</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> theArgumentValues)</code> |
| <div class="block">INTERNAL: Set the argumentValues for use with argumented queries.</div> |
| </td> |
| </tr> |
| <tr id="i150" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setBatchObjects-java.util.Map-">setBatchObjects</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><<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> batchObjects)</code> |
| <div class="block">INTERNAL: |
| Set temporary map of batched objects.</div> |
| </td> |
| </tr> |
| <tr id="i151" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setCall-org.eclipse.persistence.queries.Call-">setCall</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</code> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i152" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setCascadePolicy-int-">setCascadePolicy</a></span>(int policyConstant)</code> |
| <div class="block">INTERNAL: Set the cascade policy.</div> |
| </td> |
| </tr> |
| <tr id="i153" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDatasourceCall-org.eclipse.persistence.queries.Call-">setDatasourceCall</a></span>(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</code> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query.</div> |
| </td> |
| </tr> |
| <tr id="i154" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</code> |
| <div class="block">INTERNAL: Set the descriptor for the query.</div> |
| </td> |
| </tr> |
| <tr id="i155" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setDoNotRedirect-boolean-">setDoNotRedirect</a></span>(boolean doNotRedirect)</code> |
| <div class="block">This method is used in combination with redirected queries.</div> |
| </td> |
| </tr> |
| <tr id="i156" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setEJBQLString-java.lang.String-">setEJBQLString</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> ejbqlString)</code> |
| <div class="block">PUBLIC: Set the EJBQL string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i157" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setExecutionSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</code> |
| <div class="block">INTERNAL: Set the execution session.</div> |
| </td> |
| </tr> |
| <tr id="i158" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setFlushOnExecute-java.lang.Boolean-">setFlushOnExecute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> flushMode)</code> |
| <div class="block">PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute |
| is true EclipseLink will write changes to the database before executing |
| the query.</div> |
| </td> |
| </tr> |
| <tr id="i159" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setHintString-java.lang.String-">setHintString</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> newHintString)</code> |
| <div class="block">Used to set a database hint string on the query.</div> |
| </td> |
| </tr> |
| <tr id="i160" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsCustomQueryUsed-boolean-">setIsCustomQueryUsed</a></span>(boolean isCustomQueryUsed)</code> |
| <div class="block">INTERNAL: PERF: Set if this query will use the descriptor custom query |
| instead of executing itself.</div> |
| </td> |
| </tr> |
| <tr id="i161" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsExecutionClone-boolean-">setIsExecutionClone</a></span>(boolean isExecutionClone)</code> |
| <div class="block">INTERNAL: PERF: Set if the query is an execution clone.</div> |
| </td> |
| </tr> |
| <tr id="i162" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsNativeConnectionRequired-boolean-">setIsNativeConnectionRequired</a></span>(boolean isNativeConnectionRequired)</code> |
| <div class="block">ADVANCED: Set if the descriptor requires usage of a native (unwrapped) |
| JDBC connection.</div> |
| </td> |
| </tr> |
| <tr id="i163" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsPrepared-boolean-">setIsPrepared</a></span>(boolean isPrepared)</code> |
| <div class="block">INTERNAL: If changes are made to the query that affect the derived SQL or |
| Call parameters the query needs to be prepared again.</div> |
| </td> |
| </tr> |
| <tr id="i164" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsUserDefined-boolean-">setIsUserDefined</a></span>(boolean isUserDefined)</code> |
| <div class="block">INTERNAL: Set if the query is a custom user defined query.</div> |
| </td> |
| </tr> |
| <tr id="i165" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setIsUserDefinedSQLCall-boolean-">setIsUserDefinedSQLCall</a></span>(boolean isUserDefinedSQLCall)</code> |
| <div class="block">INTERNAL: Set if the query is a custom user defined sql call query.</div> |
| </td> |
| </tr> |
| <tr id="i166" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setJPQLString-java.lang.String-">setJPQLString</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> jpqlString)</code> |
| <div class="block">PUBLIC: Set the JPQL string of the query.</div> |
| </td> |
| </tr> |
| <tr id="i167" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setName-java.lang.String-">setName</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> queryName)</code> |
| <div class="block">PUBLIC: Set the query's name.</div> |
| </td> |
| </tr> |
| <tr id="i168" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setNullableArguments-java.util.List-">setNullableArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> nullableArguments)</code> |
| <div class="block">INTERNAL: |
| Set the list of arguments to check for null.</div> |
| </td> |
| </tr> |
| <tr id="i169" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setParameterDelimiter-java.lang.String-">setParameterDelimiter</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> aParameterDelimiter)</code> |
| <div class="block">INTERNAL: |
| Set the String char used to delimit an SQL parameter.</div> |
| </td> |
| </tr> |
| <tr id="i170" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setPartitioningPolicy-org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy-">setPartitioningPolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a> partitioningPolicy)</code> |
| <div class="block">PUBLIC: |
| Set the query's partitioning policy.</div> |
| </td> |
| </tr> |
| <tr id="i171" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setProperties-java.util.Map-">setProperties</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><<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> properties)</code> |
| <div class="block">INTERNAL: Property support used by mappings.</div> |
| </td> |
| </tr> |
| <tr id="i172" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setProperty-java.lang.Object-java.lang.Object-">setProperty</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> property, |
| <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">INTERNAL: Property support used by mappings to store temporary stuff.</div> |
| </td> |
| </tr> |
| <tr id="i173" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryMechanism-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-">setQueryMechanism</a></span>(org.eclipse.persistence.internal.queries.DatabaseQueryMechanism queryMechanism)</code> |
| <div class="block">Set the query mechanism for the query.</div> |
| </td> |
| </tr> |
| <tr id="i174" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeout-int-">setQueryTimeout</a></span>(int queryTimeout)</code> |
| <div class="block">PUBLIC: Set the number of seconds the driver will wait for a Statement to |
| execute to the given number of seconds.</div> |
| </td> |
| </tr> |
| <tr id="i175" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setQueryTimeoutUnit-java.util.concurrent.TimeUnit-">setQueryTimeoutUnit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> queryTimeoutUnit)</code> </td> |
| </tr> |
| <tr id="i176" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setRedirector-org.eclipse.persistence.queries.QueryRedirector-">setRedirector</a></span>(<a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> redirector)</code> |
| <div class="block">PUBLIC: Set the query redirector.</div> |
| </td> |
| </tr> |
| <tr id="i177" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSelectionCriteria-org.eclipse.persistence.expressions.Expression-">setSelectionCriteria</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> expression)</code> |
| <div class="block">PUBLIC: To any user of this object.</div> |
| </td> |
| </tr> |
| <tr id="i178" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: Set the session for the query</div> |
| </td> |
| </tr> |
| <tr id="i179" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSessionName-java.lang.String-">setSessionName</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> sessionName)</code> |
| <div class="block">PUBLIC: Set the name of the session that the query should be executed |
| under.</div> |
| </td> |
| </tr> |
| <tr id="i180" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-boolean-">setShouldBindAllParameters</a></span>(boolean shouldBindAllParameters)</code> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </td> |
| </tr> |
| <tr id="i181" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldBindAllParameters-java.lang.Boolean-">setShouldBindAllParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> bindAllParams)</code> |
| <div class="block">INTERNAL: Sets the internal tri-state value of shouldBindAllParams Used |
| to cascade this value to other queries</div> |
| </td> |
| </tr> |
| <tr id="i182" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldCacheStatement-boolean-">setShouldCacheStatement</a></span>(boolean shouldCacheStatement)</code> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </td> |
| </tr> |
| <tr id="i183" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldMaintainCache-boolean-">setShouldMaintainCache</a></span>(boolean shouldMaintainCache)</code> |
| <div class="block">PUBLIC: Set if the identity map (cache) should be used or not.</div> |
| </td> |
| </tr> |
| <tr id="i184" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldPrepare-boolean-">setShouldPrepare</a></span>(boolean shouldPrepare)</code> |
| <div class="block">PUBLIC: Set if the query should be prepared.</div> |
| </td> |
| </tr> |
| <tr id="i185" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldRetrieveBypassCache-boolean-">setShouldRetrieveBypassCache</a></span>(boolean shouldRetrieveBypassCache)</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i186" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldStoreBypassCache-boolean-">setShouldStoreBypassCache</a></span>(boolean shouldStoreBypassCache)</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i187" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldUseWrapperPolicy-boolean-">setShouldUseWrapperPolicy</a></span>(boolean shouldUseWrapperPolicy)</code> |
| <div class="block">ADVANCED: The wrapper policy can be enable on a query.</div> |
| </td> |
| </tr> |
| <tr id="i188" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setShouldValidateUpdateCallCacheUse-boolean-">setShouldValidateUpdateCallCacheUse</a></span>(boolean shouldCheckUpdateCallCacheUse)</code> |
| <div class="block">INTERNAL: |
| Set if additional validation should be performed before the query uses |
| the update call cache.</div> |
| </td> |
| </tr> |
| <tr id="i189" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSourceMapping-org.eclipse.persistence.mappings.DatabaseMapping-">setSourceMapping</a></span>(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> sourceMapping)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i190" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSQLStatement-org.eclipse.persistence.internal.expressions.SQLStatement-">setSQLStatement</a></span>(org.eclipse.persistence.internal.expressions.SQLStatement sqlStatement)</code> |
| <div class="block">PUBLIC: To any user of this object.</div> |
| </td> |
| </tr> |
| <tr id="i191" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setSQLString-java.lang.String-">setSQLString</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> sqlString)</code> |
| <div class="block">PUBLIC: To any user of this object.</div> |
| </td> |
| </tr> |
| <tr id="i192" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setTranslationRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</code> |
| <div class="block">INTERNAL: Set the row for translation</div> |
| </td> |
| </tr> |
| <tr id="i193" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldAllowNativeSQLQuery-boolean-">shouldAllowNativeSQLQuery</a></span>(boolean projectAllowsNativeQueries)</code> |
| <div class="block">INTERNAL: |
| Return true if this individual query should allow native a SQL call |
| to be issued.</div> |
| </td> |
| </tr> |
| <tr id="i194" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldBindAllParameters--">shouldBindAllParameters</a></span>()</code> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </td> |
| </tr> |
| <tr id="i195" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCacheStatement--">shouldCacheStatement</a></span>()</code> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </td> |
| </tr> |
| <tr id="i196" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeAllParts--">shouldCascadeAllParts</a></span>()</code> |
| <div class="block">PUBLIC: Flag used to determine if all parts should be cascaded</div> |
| </td> |
| </tr> |
| <tr id="i197" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeByMapping--">shouldCascadeByMapping</a></span>()</code> |
| <div class="block">PUBLIC: Mappings should be checked to determined if the current operation |
| should be cascaded to the objects referenced.</div> |
| </td> |
| </tr> |
| <tr id="i198" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeOnlyDependentParts--">shouldCascadeOnlyDependentParts</a></span>()</code> |
| <div class="block">INTERNAL: Flag used for unit of works cascade policy.</div> |
| </td> |
| </tr> |
| <tr id="i199" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadeParts--">shouldCascadeParts</a></span>()</code> |
| <div class="block">PUBLIC: Flag used to determine if any parts should be cascaded</div> |
| </td> |
| </tr> |
| <tr id="i200" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCascadePrivateParts--">shouldCascadePrivateParts</a></span>()</code> |
| <div class="block">PUBLIC: Flag used to determine if any private parts should be cascaded</div> |
| </td> |
| </tr> |
| <tr id="i201" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldCloneCall--">shouldCloneCall</a></span>()</code> |
| <div class="block">INTERNAL: Flag used to determine if the call needs to be cloned.</div> |
| </td> |
| </tr> |
| <tr id="i202" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldIgnoreBindAllParameters--">shouldIgnoreBindAllParameters</a></span>()</code> |
| <div class="block">PUBLIC: Local shouldBindAllParameters() should be ignored, Session's |
| shouldBindAllParameters() should be used.</div> |
| </td> |
| </tr> |
| <tr id="i203" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldIgnoreCacheStatement--">shouldIgnoreCacheStatement</a></span>()</code> |
| <div class="block">PUBLIC: Local shouldCacheStatement() should be ignored, Session's |
| shouldCacheAllStatements() should be used.</div> |
| </td> |
| </tr> |
| <tr id="i204" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldMaintainCache--">shouldMaintainCache</a></span>()</code> |
| <div class="block">PUBLIC: Return if the identity map (cache) should be used or not.</div> |
| </td> |
| </tr> |
| <tr id="i205" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare--">shouldPrepare</a></span>()</code> |
| <div class="block">PUBLIC: Return if the query should be prepared.</div> |
| </td> |
| </tr> |
| <tr id="i206" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldPrepare-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">shouldPrepare</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Check if the query should be prepared, or dynamic, depending on the arguments.</div> |
| </td> |
| </tr> |
| <tr id="i207" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldRetrieveBypassCache--">shouldRetrieveBypassCache</a></span>()</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i208" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldStoreBypassCache--">shouldStoreBypassCache</a></span>()</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i209" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldUseWrapperPolicy--">shouldUseWrapperPolicy</a></span>()</code> |
| <div class="block">ADVANCED: The wrapper policy can be enabled on a query.</div> |
| </td> |
| </tr> |
| <tr id="i210" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#shouldValidateUpdateCallCacheUse--">shouldValidateUpdateCallCacheUse</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return true if additional validation should be performed before the query uses |
| the update call cache, false otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i211" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#storeBypassCache--">storeBypassCache</a></span>()</code> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache.</div> |
| </td> |
| </tr> |
| <tr id="i212" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#toString--">toString</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#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="BATCH_FETCH_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BATCH_FETCH_PROPERTY</h4> |
| <pre>public static final <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> BATCH_FETCH_PROPERTY</pre> |
| <div class="block">INTERNAL: Property used for batch fetching in non object queries.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.BATCH_FETCH_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="name"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre>protected <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">Queries can be given a name and registered with a descriptor to allow |
| common queries to be reused.</div> |
| </li> |
| </ul> |
| <a name="arguments"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arguments</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> arguments</pre> |
| <div class="block">Arguments can be given and specified to predefined queries to allow |
| reuse.</div> |
| </li> |
| </ul> |
| <a name="argumentFields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>argumentFields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> argumentFields</pre> |
| <div class="block">PERF: Argument fields are cached in prepare to avoid rebuilding on each |
| execution.</div> |
| </li> |
| </ul> |
| <a name="argumentValues"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>argumentValues</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentValues</pre> |
| <div class="block">Arguments values can be given and specified to predefined queries to |
| allow reuse.</div> |
| </li> |
| </ul> |
| <a name="argumentTypes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>argumentTypes</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypes</pre> |
| <div class="block">Needed to differentiate queries with the same name.</div> |
| </li> |
| </ul> |
| <a name="argumentTypeNames"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>argumentTypeNames</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypeNames</pre> |
| <div class="block">Used to build a list of argumentTypes by name pre-initialization</div> |
| </li> |
| </ul> |
| <a name="argumentParameterTypes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>argumentParameterTypes</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a>> argumentParameterTypes</pre> |
| </li> |
| </ul> |
| <a name="descriptor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptor</h4> |
| <pre>protected transient <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor</pre> |
| <div class="block">The descriptor cached on the prepare for object level queries.</div> |
| </li> |
| </ul> |
| <a name="descriptors"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptors</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>> descriptors</pre> |
| <div class="block">The list of descriptors this query deals with. Set via JPA processing for table per tenant queries</div> |
| </li> |
| </ul> |
| <a name="queryMechanism"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryMechanism</h4> |
| <pre>protected org.eclipse.persistence.internal.queries.DatabaseQueryMechanism queryMechanism</pre> |
| <div class="block">The query mechanism determines the mechanism on how the database will be |
| accessed.</div> |
| </li> |
| </ul> |
| <a name="redirector"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>redirector</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> redirector</pre> |
| <div class="block">A redirector allows for a queries execution to be the execution of a |
| piece of code.</div> |
| </li> |
| </ul> |
| <a name="doNotRedirect"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doNotRedirect</h4> |
| <pre>protected boolean doNotRedirect</pre> |
| <div class="block">Can be set to true in the case there is a redirector or a default |
| redirector but the user does not want the query redirected.</div> |
| </li> |
| </ul> |
| <a name="shouldMaintainCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldMaintainCache</h4> |
| <pre>protected boolean shouldMaintainCache</pre> |
| <div class="block">Flag used for a query to bypass the identitymap and unit of work.</div> |
| </li> |
| </ul> |
| <a name="shouldRetrieveBypassCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldRetrieveBypassCache</h4> |
| <pre>protected boolean shouldRetrieveBypassCache</pre> |
| <div class="block">JPA flags to control the shared cache</div> |
| </li> |
| </ul> |
| <a name="shouldStoreBypassCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldStoreBypassCache</h4> |
| <pre>protected boolean shouldStoreBypassCache</pre> |
| </li> |
| </ul> |
| <a name="allowNativeSQLQuery"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allowNativeSQLQuery</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> allowNativeSQLQuery</pre> |
| <div class="block">Property used to override a persistence unit level that disallows native |
| SQL queries.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/sessions/Project.html#setAllowNativeSQLQueries-boolean-"><code>Project.setAllowNativeSQLQueries(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="properties"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</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>,<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>> properties</pre> |
| <div class="block">Internally used by the mappings as a temporary store.</div> |
| </li> |
| </ul> |
| <a name="session"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>session</h4> |
| <pre>protected transient org.eclipse.persistence.internal.sessions.AbstractSession session</pre> |
| <div class="block">Only used after the query is cloned for execution to store the session |
| under which the query was executed.</div> |
| </li> |
| </ul> |
| <a name="executionSession"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executionSession</h4> |
| <pre>protected transient org.eclipse.persistence.internal.sessions.AbstractSession executionSession</pre> |
| <div class="block">Only used after the query is cloned for execution to store the execution |
| session under which the query was executed.</div> |
| </li> |
| </ul> |
| <a name="accessors"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accessors</h4> |
| <pre>protected transient <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor> accessors</pre> |
| <div class="block">Connection to use for database access, required for server session |
| connection pooling. |
| There can be multiple connections with partitioning and replication.</div> |
| </li> |
| </ul> |
| <a name="translationRow"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translationRow</h4> |
| <pre>protected org.eclipse.persistence.internal.sessions.AbstractRecord translationRow</pre> |
| <div class="block">Mappings and the descriptor use parameterized mechanisms that will be |
| translated with the data from the row.</div> |
| </li> |
| </ul> |
| <a name="isUserDefined"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserDefined</h4> |
| <pre>protected boolean isUserDefined</pre> |
| <div class="block">Internal flag used to bypass user define queries when executing one for |
| custom sql/query support.</div> |
| </li> |
| </ul> |
| <a name="isUserDefinedSQLCall"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserDefinedSQLCall</h4> |
| <pre>protected boolean isUserDefinedSQLCall</pre> |
| <div class="block">Internal flag used to bypass user define queries when executing one for |
| custom sql/query support.</div> |
| </li> |
| </ul> |
| <a name="cascadePolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadePolicy</h4> |
| <pre>protected int cascadePolicy</pre> |
| <div class="block">Policy that determines how the query will cascade to its object's parts.</div> |
| </li> |
| </ul> |
| <a name="sessionName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sessionName</h4> |
| <pre>protected <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> sessionName</pre> |
| <div class="block">Used to override the default session in the session broker.</div> |
| </li> |
| </ul> |
| <a name="isPrepared"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrepared</h4> |
| <pre>protected boolean isPrepared</pre> |
| <div class="block">Queries prepare common stated in themselves.</div> |
| </li> |
| </ul> |
| <a name="shouldCloneCall"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCloneCall</h4> |
| <pre>protected boolean shouldCloneCall</pre> |
| <div class="block">Used to indicate whether or not the call needs to be cloned.</div> |
| </li> |
| </ul> |
| <a name="shouldPrepare"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldPrepare</h4> |
| <pre>protected boolean shouldPrepare</pre> |
| <div class="block">Allow for the prepare of queries to be turned off, this allow for dynamic |
| non-pre SQL generated queries.</div> |
| </li> |
| </ul> |
| <a name="nullableArguments"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullableArguments</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> nullableArguments</pre> |
| <div class="block">List of arguments to check for null. |
| If any are null, the query needs to be re-prepared.</div> |
| </li> |
| </ul> |
| <a name="shouldBindAllParameters"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldBindAllParameters</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> shouldBindAllParameters</pre> |
| <div class="block">Bind all arguments to the SQL statement.</div> |
| </li> |
| </ul> |
| <a name="shouldCacheStatement"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCacheStatement</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> shouldCacheStatement</pre> |
| <div class="block">Cache the prepared statement, this requires full parameter binding as |
| well.</div> |
| </li> |
| </ul> |
| <a name="shouldUseWrapperPolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseWrapperPolicy</h4> |
| <pre>protected boolean shouldUseWrapperPolicy</pre> |
| <div class="block">Use the WrapperPolicy for the objects returned by the query</div> |
| </li> |
| </ul> |
| <a name="sourceMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sourceMapping</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> sourceMapping</pre> |
| <div class="block">Table per class requires multiple query executions. Internally we prepare |
| those queries and cache them against the source mapping's selection |
| query. When queries are executed they are cloned so we need a mechanism |
| to keep a reference back to the actual selection query so that we can |
| successfully look up and chain query executions within a table per class |
| inheritance hierarchy.</div> |
| </li> |
| </ul> |
| <a name="queryTimeout"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryTimeout</h4> |
| <pre>protected int queryTimeout</pre> |
| <div class="block">queryTimeout has three possible settings: DefaultTimeout, NoTimeout, and |
| 1..N This applies to both DatabaseQuery.queryTimeout and |
| DescriptorQueryManager.queryTimeout |
| |
| DatabaseQuery.queryTimeout: - DefaultTimeout: get queryTimeout from |
| DescriptorQueryManager - NoTimeout, 1..N: overrides queryTimeout in |
| DescriptorQueryManager |
| |
| DescriptorQueryManager.queryTimeout: - DefaultTimeout: get queryTimeout |
| from parent DescriptorQueryManager. If there is no parent, default to |
| NoTimeout - NoTimeout, 1..N: overrides parent queryTimeout</div> |
| </li> |
| </ul> |
| <a name="queryTimeoutUnit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryTimeoutUnit</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> queryTimeoutUnit</pre> |
| </li> |
| </ul> |
| <a name="NoCascading"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NoCascading</h4> |
| <pre>public static final int NoCascading</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.NoCascading">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CascadePrivateParts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CascadePrivateParts</h4> |
| <pre>public static final int CascadePrivateParts</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.CascadePrivateParts">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CascadeAllParts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CascadeAllParts</h4> |
| <pre>public static final int CascadeAllParts</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.CascadeAllParts">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CascadeDependentParts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CascadeDependentParts</h4> |
| <pre>public static final int CascadeDependentParts</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.CascadeDependentParts">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CascadeAggregateDelete"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CascadeAggregateDelete</h4> |
| <pre>public static final int CascadeAggregateDelete</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.CascadeAggregateDelete">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CascadeByMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CascadeByMapping</h4> |
| <pre>public static final int CascadeByMapping</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.persistence.queries.DatabaseQuery.CascadeByMapping">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hintString"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hintString</h4> |
| <pre>protected <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> hintString</pre> |
| <div class="block">Used for adding hints to the query string in oracle</div> |
| </li> |
| </ul> |
| <a name="flushOnExecute"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flushOnExecute</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> flushOnExecute</pre> |
| </li> |
| </ul> |
| <a name="isExecutionClone"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExecutionClone</h4> |
| <pre>protected boolean isExecutionClone</pre> |
| <div class="block">PERF: Determines if the query has already been cloned for execution, to |
| avoid duplicate cloning.</div> |
| </li> |
| </ul> |
| <a name="isCustomQueryUsed"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCustomQueryUsed</h4> |
| <pre>protected volatile <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isCustomQueryUsed</pre> |
| <div class="block">PERF: Store if this query will use the descriptor custom query.</div> |
| </li> |
| </ul> |
| <a name="isNativeConnectionRequired"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNativeConnectionRequired</h4> |
| <pre>protected boolean isNativeConnectionRequired</pre> |
| <div class="block">Allow connection unwrapping to be configured.</div> |
| </li> |
| </ul> |
| <a name="monitorName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>monitorName</h4> |
| <pre>protected transient <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> monitorName</pre> |
| <div class="block">Return the name to use for the query in performance monitoring.</div> |
| </li> |
| </ul> |
| <a name="shouldValidateUpdateCallCacheUse"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldValidateUpdateCallCacheUse</h4> |
| <pre>protected boolean shouldValidateUpdateCallCacheUse</pre> |
| <div class="block">Allow additional validation to be performed before using the update call cache</div> |
| </li> |
| </ul> |
| <a name="partitioningPolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partitioningPolicy</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a> partitioningPolicy</pre> |
| <div class="block">Allow queries to be targeted at specific connection pools.</div> |
| </li> |
| </ul> |
| <a name="parameterDelimiter"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parameterDelimiter</h4> |
| <pre>protected <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> parameterDelimiter</pre> |
| <div class="block">Allow the reserved pound char used to delimit bind parameters to be overridden</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DatabaseQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DatabaseQuery</h4> |
| <pre>public DatabaseQuery()</pre> |
| <div class="block">PUBLIC: Initialize the state of the query</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPartitioningPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitioningPolicy</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a> getPartitioningPolicy()</pre> |
| <div class="block">PUBLIC: |
| Return the query's partitioning policy.</div> |
| </li> |
| </ul> |
| <a name="setPartitioningPolicy-org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPartitioningPolicy</h4> |
| <pre>public void setPartitioningPolicy(<a href="../../../../org/eclipse/persistence/descriptors/partitioning/PartitioningPolicy.html" title="class in org.eclipse.persistence.descriptors.partitioning">PartitioningPolicy</a> partitioningPolicy)</pre> |
| <div class="block">PUBLIC: |
| Set the query's partitioning policy. |
| A PartitioningPolicy is used to partition, load-balance or replicate data across multiple difference databases |
| or across a database cluster such as Oracle RAC. |
| Partitioning can provide improved scalability by allowing multiple database machines to service requests. |
| Setting a policy on a query will override the descriptor and session defaults.</div> |
| </li> |
| </ul> |
| <a name="getMonitorName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMonitorName</h4> |
| <pre>public <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> getMonitorName()</pre> |
| <div class="block">INTERNAL: |
| Return the name to use for the query in performance monitoring.</div> |
| </li> |
| </ul> |
| <a name="resetMonitorName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetMonitorName</h4> |
| <pre>public void resetMonitorName()</pre> |
| <div class="block">INTERNAL: |
| Return the name to use for the query in performance monitoring.</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName)</pre> |
| <div class="block">PUBLIC: Add the argument named argumentName. This will cause the |
| translation of references of argumentName in the receiver's expression, |
| with the value of the argument as supplied to the query in order from |
| executeQuery()</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName, |
| <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> type)</pre> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type. This will |
| cause the translation of references of argumentName in the receiver's |
| expression, with the value of the argument as supplied to the query in |
| order from executeQuery(). Specifying the class type is important if |
| identically named queries are used but with different argument lists.</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName, |
| <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> type, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a> parameterType)</pre> |
| <div class="block">INTERNAL: Add the argument named argumentName. This method was added to maintain |
| information about whether parameters are positional or named for JPQL query introspeciton |
| API</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName, |
| <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> type, |
| boolean nullable)</pre> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type. This will |
| cause the translation of references of argumentName in the receiver's |
| expression, with the value of the argument as supplied to the query in |
| order from executeQuery(). Specifying the class type is important if |
| identically named queries are used but with different argument lists. |
| If the argument can be null, and null must be treated differently in the |
| generated SQL, then nullable should be set to true.</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-java.lang.Class-org.eclipse.persistence.queries.DatabaseQuery.ParameterType-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName, |
| <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> type, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a> argumentParameterType, |
| boolean nullable)</pre> |
| <div class="block">INTERNAL: Add the argument named argumentName. This method was added to maintain |
| information about whether parameters are positional or named for JPQL query introspeciton |
| API</div> |
| </li> |
| </ul> |
| <a name="addArgument-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgument</h4> |
| <pre>public void addArgument(<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> argumentName, |
| <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> typeAsString)</pre> |
| <div class="block">PUBLIC: Add the argument named argumentName and its class type. This will |
| cause the translation of references of argumentName in the receiver's |
| expression, with the value of the argument as supplied to the query in |
| order from executeQuery(). Specifying the class type is important if |
| identically named queries are used but with different argument lists.</div> |
| </li> |
| </ul> |
| <a name="addArgumentByTypeName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgumentByTypeName</h4> |
| <pre>public void addArgumentByTypeName(<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> argumentName, |
| <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> typeAsString)</pre> |
| <div class="block">INTERNAL: Add an argument to the query, but do not resolve the class yet. |
| This is useful for building a query without putting the domain classes on |
| the classpath for the Mapping Workbench.</div> |
| </li> |
| </ul> |
| <a name="addArgumentValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgumentValue</h4> |
| <pre>public void addArgumentValue(<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> argumentValue)</pre> |
| <div class="block">PUBLIC: Add the argumentValue. Argument values must be added in the same |
| order the arguments are defined.</div> |
| </li> |
| </ul> |
| <a name="addArgumentValues-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addArgumentValues</h4> |
| <pre>public void addArgumentValues(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> theArgumentValues)</pre> |
| <div class="block">PUBLIC: Add the argumentValues to the query. Argument values must be |
| added in the same order the arguments are defined.</div> |
| </li> |
| </ul> |
| <a name="addCall-org.eclipse.persistence.queries.Call-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCall</h4> |
| <pre>public void addCall(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</pre> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query. This may be used |
| for multiple SQL executions to be mapped to a single query. This cannot |
| be used for cursored selects, delete alls or does exists.</div> |
| </li> |
| </ul> |
| <a name="addStatement-org.eclipse.persistence.internal.expressions.SQLStatement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addStatement</h4> |
| <pre>public void addStatement(org.eclipse.persistence.internal.expressions.SQLStatement statement)</pre> |
| <div class="block">PUBLIC: Used to define a statement level query. This may be used for |
| multiple SQL executions to be mapped to a single query. This cannot be |
| used for cursored selects, delete all(s) or does exists.</div> |
| </li> |
| </ul> |
| <a name="bindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindAllParameters</h4> |
| <pre>public void bindAllParameters()</pre> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </li> |
| </ul> |
| <a name="buildSelectionCriteria-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildSelectionCriteria</h4> |
| <pre>protected void buildSelectionCriteria(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: In the case of EJBQL, an expression needs to be generated. |
| Build the required expression.</div> |
| </li> |
| </ul> |
| <a name="cacheStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cacheStatement</h4> |
| <pre>public void cacheStatement()</pre> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </li> |
| </ul> |
| <a name="cascadeAllParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadeAllParts</h4> |
| <pre>public void cascadeAllParts()</pre> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all objects related to the queries object(s). This includes private and |
| independent relationships, but not read-only relationships. This will |
| still stop on uninstantiated indirection objects except for deletion. |
| Great caution should be used in using the property as the query may |
| effect a large number of objects. This policy is used by the unit of work |
| to ensure persistence by reachability.</div> |
| </li> |
| </ul> |
| <a name="cascadeByMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadeByMapping</h4> |
| <pre>public void cascadeByMapping()</pre> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all related objects where the mapping has been set to cascade the merge.</div> |
| </li> |
| </ul> |
| <a name="cascadeOnlyDependentParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadeOnlyDependentParts</h4> |
| <pre>public void cascadeOnlyDependentParts()</pre> |
| <div class="block">INTERNAL: Used by unit of work, only cascades constraint dependencies.</div> |
| </li> |
| </ul> |
| <a name="cascadePrivateParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadePrivateParts</h4> |
| <pre>public void cascadePrivateParts()</pre> |
| <div class="block">PUBLIC: Cascade the query and its properties on the queries object(s) and |
| all privately owned objects related to the queries object(s). This is the |
| default for write and delete queries. This policy should normally be used |
| for refreshing, otherwise you could refresh half of any object.</div> |
| </li> |
| </ul> |
| <a name="checkDescriptor-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkDescriptor</h4> |
| <pre>public void checkDescriptor(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre> |
| <div class="block">INTERNAL: Ensure that the descriptor has been set.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkEarlyReturn-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkEarlyReturn</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> checkEarlyReturn(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</pre> |
| <div class="block">INTERNAL: Check to see if this query already knows the return value |
| without performing any further work.</div> |
| </li> |
| </ul> |
| <a name="checkForCustomQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkForCustomQuery</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> checkForCustomQuery(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</pre> |
| <div class="block">INTERNAL: Check to see if a custom query should be used for this query. |
| This is done before the query is copied and prepared/executed. null means |
| there is none.</div> |
| </li> |
| </ul> |
| <a name="checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPrepare</h4> |
| <pre>public void checkPrepare(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</pre> |
| <div class="block">INTERNAL: Check to see if this query needs to be prepare and prepare it. |
| The prepare is done on the original query to ensure that the work is not |
| repeated.</div> |
| </li> |
| </ul> |
| <a name="prepareInternal-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareInternal</h4> |
| <pre>public void prepareInternal(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: Call the prepare on the query.</div> |
| </li> |
| </ul> |
| <a name="checkPrepare-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkPrepare</h4> |
| <pre>public void checkPrepare(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, |
| boolean force)</pre> |
| <div class="block">INTERNAL: Check to see if this query needs to be prepare and prepare it. |
| The prepare is done on the original query to ensure that the work is not |
| repeated.</div> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</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> clone()</pre> |
| <div class="block">INTERNAL: Clone the query</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><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></code> in class <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clonedQueryExecutionComplete-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clonedQueryExecutionComplete</h4> |
| <pre>protected void clonedQueryExecutionComplete(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL Used to give the subclasses opportunity to copy aspects of the |
| cloned query to the original query.</div> |
| </li> |
| </ul> |
| <a name="convertClassNamesToClasses-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertClassNamesToClasses</h4> |
| <pre>public void convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">INTERNAL: Convert all the class-name-based settings in this query to |
| actual class-based settings This method is implemented by subclasses as |
| necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoader</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dontBindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dontBindAllParameters</h4> |
| <pre>public void dontBindAllParameters()</pre> |
| <div class="block">PUBLIC: Do not Bind all arguments to any SQL statement.</div> |
| </li> |
| </ul> |
| <a name="dontCacheStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dontCacheStatement</h4> |
| <pre>public void dontCacheStatement()</pre> |
| <div class="block">PUBLIC: Don't cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </li> |
| </ul> |
| <a name="dontCascadeParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dontCascadeParts</h4> |
| <pre>public void dontCascadeParts()</pre> |
| <div class="block">PUBLIC: Do not cascade the query and its properties on the queries |
| object(s) relationships. This does not effect the queries private parts |
| but only the object(s) direct row-level attributes. This is the default |
| for read queries and can be used in writing if it is known that only |
| row-level attributes changed, or to resolve circular foreign key |
| dependencies.</div> |
| </li> |
| </ul> |
| <a name="dontMaintainCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dontMaintainCache</h4> |
| <pre>public void dontMaintainCache()</pre> |
| <div class="block">PUBLIC: Set for the identity map (cache) to be ignored completely. The |
| cache check will be skipped and the result will not be put into the |
| identity map. This can be used to retrieve the exact state of an object |
| on the database. By default the identity map is always maintained.</div> |
| </li> |
| </ul> |
| <a name="executeDatabaseQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeDatabaseQuery</h4> |
| <pre>public abstract <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> executeDatabaseQuery() |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a>, |
| <a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></pre> |
| <div class="block">INTERNAL: Execute the query</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>- the result of executing the query.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code> - - an error has occurred on the database.</dd> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></code> - - an error has occurred using the optimistic lock feature.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="executeInUnitOfWork-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>executeInUnitOfWork</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> executeInUnitOfWork(org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a>, |
| <a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></pre> |
| <div class="block">INTERNAL: Override query execution where Session is a UnitOfWork. |
| <p> |
| If there are objects in the cache return the results of the cache lookup.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unitOfWork</code> - - the session in which the receiver will be executed.</dd> |
| <dd><code>translationRow</code> - - the arguments</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object, the result of executing the query.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code> - - an error has occurred on the database.</dd> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></code> - - an error has occurred using the optimistic lock feature.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</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> execute(org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a>, |
| <a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></pre> |
| <div class="block">INTERNAL: Execute the query. If there are objects in the cache return the |
| results of the cache lookup.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - - the session in which the receiver will be executed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object, the result of executing the query.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code> - - an error has occurred on the database.</dd> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/OptimisticLockException.html" title="class in org.eclipse.persistence.exceptions">OptimisticLockException</a></code> - - an error has occurred using the optimistic lock feature.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extractRemoteResult-org.eclipse.persistence.internal.sessions.remote.Transporter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractRemoteResult</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> extractRemoteResult(org.eclipse.persistence.internal.sessions.remote.Transporter transporter)</pre> |
| <div class="block">INTERNAL: Extract the correct query result from the transporter.</div> |
| </li> |
| </ul> |
| <a name="getAccessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessor</h4> |
| <pre>public org.eclipse.persistence.internal.databaseaccess.Accessor getAccessor()</pre> |
| <div class="block">INTERNAL: Return the accessor.</div> |
| </li> |
| </ul> |
| <a name="getAccessors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessors</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor> getAccessors()</pre> |
| <div class="block">INTERNAL: Return the accessors.</div> |
| </li> |
| </ul> |
| <a name="getArguments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArguments</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getArguments()</pre> |
| <div class="block">INTERNAL: Return the arguments for use with the pre-defined query option</div> |
| </li> |
| </ul> |
| <a name="getArgumentParameterTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentParameterTypes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries">DatabaseQuery.ParameterType</a>> getArgumentParameterTypes()</pre> |
| <div class="block">INTERNAL: |
| Used to calculate parameter types in JPQL</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="getArgumentTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentTypes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getArgumentTypes()</pre> |
| <div class="block">INTERNAL: Return the argumentTypes for use with the pre-defined query |
| option</div> |
| </li> |
| </ul> |
| <a name="getArgumentTypeNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentTypeNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getArgumentTypeNames()</pre> |
| <div class="block">INTERNAL: Return the argumentTypeNames for use with the pre-defined query |
| option These are used pre-initialization to construct the argumentTypes |
| list.</div> |
| </li> |
| </ul> |
| <a name="setArgumentTypes-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArgumentTypes</h4> |
| <pre>public void setArgumentTypes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypes)</pre> |
| <div class="block">INTERNAL: Set the argumentTypes for use with the pre-defined query option</div> |
| </li> |
| </ul> |
| <a name="setArgumentTypeNames-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArgumentTypeNames</h4> |
| <pre>public void setArgumentTypeNames(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> argumentTypeNames)</pre> |
| <div class="block">INTERNAL: Set the argumentTypes for use with the pre-defined query option</div> |
| </li> |
| </ul> |
| <a name="setArguments-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArguments</h4> |
| <pre>public void setArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> arguments)</pre> |
| <div class="block">INTERNAL: Set the arguments for use with the pre-defined query option. |
| Maintain the argumentTypes as well.</div> |
| </li> |
| </ul> |
| <a name="getArgumentValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentValues</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> getArgumentValues()</pre> |
| <div class="block">INTERNAL: Return the argumentValues for use with argumented queries.</div> |
| </li> |
| </ul> |
| <a name="setArgumentValues-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArgumentValues</h4> |
| <pre>public void setArgumentValues(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> theArgumentValues)</pre> |
| <div class="block">INTERNAL: Set the argumentValues for use with argumented queries.</div> |
| </li> |
| </ul> |
| <a name="getCall--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCall</h4> |
| <pre>public org.eclipse.persistence.internal.databaseaccess.DatabaseCall getCall()</pre> |
| <div class="block">OBSOLETE: Return the call for this query. This call contains the SQL and |
| argument list.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getDatasourceCall--"><code>getDatasourceCall()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatasourceCall--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatasourceCall</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> getDatasourceCall()</pre> |
| <div class="block">ADVANCED: Return the call for this query. This call contains the SQL and |
| argument list.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDatasourceCalls--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDatasourceCalls</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> getDatasourceCalls()</pre> |
| <div class="block">ADVANCED: Return the calls for this query. This method can be called for |
| queries with multiple calls This call contains the SQL and argument list.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCascadePolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadePolicy</h4> |
| <pre>public int getCascadePolicy()</pre> |
| <div class="block">INTERNAL: Return the cascade policy.</div> |
| </li> |
| </ul> |
| <a name="getDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> getDescriptor()</pre> |
| <div class="block">INTERNAL: Return the descriptor assigned with the reference class</div> |
| </li> |
| </ul> |
| <a name="getDescriptors--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptors</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>> getDescriptors()</pre> |
| <div class="block">INTERNAL: |
| This is here only for JPA queries and currently only populated for JPA |
| queries. JPAQuery is a jpa class and currently not part of the core.</div> |
| </li> |
| </ul> |
| <a name="getDomainClassNounName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDomainClassNounName</h4> |
| <pre>public <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> getDomainClassNounName(<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> sessionName)</pre> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass. Cached in properties</div> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <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> getName()</pre> |
| <div class="block">PUBLIC: Return the name of the query</div> |
| </li> |
| </ul> |
| <a name="getParameterDelimiter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterDelimiter</h4> |
| <pre>public <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> getParameterDelimiter()</pre> |
| <div class="block">INTERNAL: |
| Return the String used to delimit an SQL parameter.</div> |
| </li> |
| </ul> |
| <a name="getParameterDelimiterChar--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterDelimiterChar</h4> |
| <pre>public char getParameterDelimiterChar()</pre> |
| <div class="block">INTERNAL: |
| Return the char used to delimit an SQL parameter.</div> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</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>,<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>> getProperties()</pre> |
| <div class="block">INTERNAL: Property support for use by mappings.</div> |
| </li> |
| </ul> |
| <a name="getProperty-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</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> getProperty(<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> property)</pre> |
| <div class="block">INTERNAL: Property support used by mappings to store temporary stuff in |
| the query.</div> |
| </li> |
| </ul> |
| <a name="getQueryNounName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryNounName</h4> |
| <pre>public <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> getQueryNounName(<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> sessionName)</pre> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass_queryClass_queryName (if exist). Cached in properties</div> |
| </li> |
| </ul> |
| <a name="getQueryMechanism--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryMechanism</h4> |
| <pre>public org.eclipse.persistence.internal.queries.DatabaseQueryMechanism getQueryMechanism()</pre> |
| <div class="block">INTERNAL: Return the mechanism assigned to the query</div> |
| </li> |
| </ul> |
| <a name="hasQueryMechanism--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasQueryMechanism</h4> |
| <pre>public boolean hasQueryMechanism()</pre> |
| <div class="block">INTERNAL: Check if the mechanism has been set yet, used for lazy init.</div> |
| </li> |
| </ul> |
| <a name="getQueryTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeout</h4> |
| <pre>public int getQueryTimeout()</pre> |
| <div class="block">PUBLIC: Return the number of seconds the driver will wait for a Statement |
| to execute to the given number of seconds.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/DescriptorQueryManager.html#getQueryTimeout--"><code>DescriptorQueryManager.getQueryTimeout()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryTimeoutUnit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryTimeoutUnit</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> getQueryTimeoutUnit()</pre> |
| <div class="block">PUBLIC: Return the unit of time the driver will wait for a Statement to |
| execute.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/DescriptorQueryManager.html#getQueryTimeoutUnit--"><code>DescriptorQueryManager.getQueryTimeoutUnit()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultRedirector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultRedirector</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> getDefaultRedirector()</pre> |
| <div class="block">INTERNAL: Returns the specific default redirector for this query type. |
| There are numerous default query redirectors. See ClassDescriptor for |
| their types.</div> |
| </li> |
| </ul> |
| <a name="getRedirectorForQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRedirectorForQuery</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> getRedirectorForQuery()</pre> |
| <div class="block">PUBLIC: Return the query redirector. A redirector can be used in a query |
| to replace its execution with the execution of code. This can be used for |
| named or parameterized queries to allow dynamic configuration of the |
| query base on the query arguments.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries"><code>QueryRedirector</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRedirector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRedirector</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> getRedirector()</pre> |
| <div class="block">PUBLIC: Return the query redirector. A redirector can be used in a query |
| to replace its execution with the execution of code. This can be used for |
| named or parameterized queries to allow dynamic configuration of the |
| query base on the query arguments.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries"><code>QueryRedirector</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReferenceClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceClass</h4> |
| <pre>public <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> getReferenceClass()</pre> |
| <div class="block">PUBLIC: Return the domain class associated with this query. By default |
| this is null, but should be overridden in subclasses.</div> |
| </li> |
| </ul> |
| <a name="getReferenceClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceClassName</h4> |
| <pre>public <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> getReferenceClassName()</pre> |
| <div class="block">INTERNAL: return the name of the reference class. Added for Mapping |
| Workbench removal of classpath dependency. Overridden by subclasses.</div> |
| </li> |
| </ul> |
| <a name="getSelectionCriteria--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectionCriteria</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> getSelectionCriteria()</pre> |
| <div class="block">PUBLIC: Return the selection criteria of the query. This should only be |
| used with expression queries, null will be returned for others.</div> |
| </li> |
| </ul> |
| <a name="getSensorName-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSensorName</h4> |
| <pre>public <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> getSensorName(<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> operationName, |
| <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> sessionName)</pre> |
| <div class="block">INTERNAL: |
| TopLink_sessionName_domainClass_queryClass_queryName (if exist)_operationName (if exist). Cached in properties</div> |
| </li> |
| </ul> |
| <a name="getSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getSession()</pre> |
| <div class="block">INTERNAL: Return the current session.</div> |
| </li> |
| </ul> |
| <a name="getExecutionSession--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionSession</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractSession getExecutionSession()</pre> |
| <div class="block">INTERNAL: Return the execution session. This is the session used to build |
| objects returned by the query.</div> |
| </li> |
| </ul> |
| <a name="setExecutionSession-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExecutionSession</h4> |
| <pre>protected void setExecutionSession(org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</pre> |
| <div class="block">INTERNAL: Set the execution session. This is the session used to build |
| objects returned by the query.</div> |
| </li> |
| </ul> |
| <a name="getSessionName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionName</h4> |
| <pre>public <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> getSessionName()</pre> |
| <div class="block">PUBLIC: Return the name of the session that the query should be executed |
| under. This can be with the session broker to override the default |
| session.</div> |
| </li> |
| </ul> |
| <a name="getSQLStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLStatement</h4> |
| <pre>public org.eclipse.persistence.internal.expressions.SQLStatement getSQLStatement()</pre> |
| <div class="block">PUBLIC: Return the SQL statement of the query. This can only be used with |
| statement queries.</div> |
| </li> |
| </ul> |
| <a name="getJPQLString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJPQLString</h4> |
| <pre>public <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> getJPQLString()</pre> |
| <div class="block">PUBLIC: Return the JPQL string of the query.</div> |
| </li> |
| </ul> |
| <a name="getEJBQLString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEJBQLString</h4> |
| <pre>public <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> getEJBQLString()</pre> |
| <div class="block">PUBLIC: Return the EJBQL string of the query.</div> |
| </li> |
| </ul> |
| <a name="getHintString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHintString</h4> |
| <pre>public <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> getHintString()</pre> |
| <div class="block">PUBLIC: Return the current database hint string of the query.</div> |
| </li> |
| </ul> |
| <a name="getSQLString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLString</h4> |
| <pre>public <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> getSQLString()</pre> |
| <div class="block">ADVANCED: Return the SQL string of the query. This can be used for SQL |
| queries. This can also be used for normal queries if they have been |
| prepared, (i.e. query.prepareCall()).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSQLStrings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLStrings</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> getSQLStrings()</pre> |
| <div class="block">ADVANCED: Return the SQL strings of the query. Used for queries with |
| multiple calls This can be used for SQL queries. This can also be used |
| for normal queries if they have been prepared, (i.e. |
| query.prepareCall()).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getShouldBindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShouldBindAllParameters</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getShouldBindAllParameters()</pre> |
| <div class="block">INTERNAL: Returns the internal tri-state value of shouldBindParameters |
| used far cascading these settings</div> |
| </li> |
| </ul> |
| <a name="getSourceMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> getSourceMapping()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="getTranslatedSQLString-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTranslatedSQLString</h4> |
| <pre>public <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> getTranslatedSQLString(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow)</pre> |
| <div class="block">ADVANCED: This can be used to access a queries translated SQL if they |
| have been prepared, (i.e. query.prepareCall()). The Record argument is |
| one of (Record, XMLRecord) that contains the query arguments.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(org.eclipse.persistence.sessions.Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTranslatedSQLStrings-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTranslatedSQLStrings</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> getTranslatedSQLStrings(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow)</pre> |
| <div class="block">ADVANCED: This can be used to access a queries translated SQL if they |
| have been prepared, (i.e. query.prepareCall()). This method can be used |
| for queries with multiple calls.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>prepareCall(Session, Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTranslationRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTranslationRow</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractRecord getTranslationRow()</pre> |
| <div class="block">INTERNAL: Return the row for translation</div> |
| </li> |
| </ul> |
| <a name="hasAccessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAccessor</h4> |
| <pre>public boolean hasAccessor()</pre> |
| <div class="block">INTERNAL: returns true if the accessor has already been set. The |
| getAccessor() will attempt to lazily initialize it.</div> |
| </li> |
| </ul> |
| <a name="hasProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasProperties</h4> |
| <pre>public boolean hasProperties()</pre> |
| <div class="block">INTERNAL: Return if any properties exist in the query.</div> |
| </li> |
| </ul> |
| <a name="hasArguments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasArguments</h4> |
| <pre>public boolean hasArguments()</pre> |
| <div class="block">INTERNAL: Return if any arguments exist in the query.</div> |
| </li> |
| </ul> |
| <a name="hasSessionName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSessionName</h4> |
| <pre>public boolean hasSessionName()</pre> |
| <div class="block">PUBLIC: Return if a name of the session that the query should be executed |
| under has been specified. This can be with the session broker to override |
| the default session.</div> |
| </li> |
| </ul> |
| <a name="ignoreBindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ignoreBindAllParameters</h4> |
| <pre>public void ignoreBindAllParameters()</pre> |
| <div class="block">PUBLIC: Session's shouldBindAllParameters() defines whether to bind or |
| not (default setting)</div> |
| </li> |
| </ul> |
| <a name="ignoreCacheStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ignoreCacheStatement</h4> |
| <pre>public void ignoreCacheStatement()</pre> |
| <div class="block">PUBLIC: Session's shouldCacheAllStatements() defines whether to cache or |
| not (default setting)</div> |
| </li> |
| </ul> |
| <a name="isCallQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCallQuery</h4> |
| <pre>public boolean isCallQuery()</pre> |
| <div class="block">PUBLIC: Return true if this query uses SQL, a stored procedure, or SDK |
| call.</div> |
| </li> |
| </ul> |
| <a name="isCascadeOfAggregateDelete--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCascadeOfAggregateDelete</h4> |
| <pre>public boolean isCascadeOfAggregateDelete()</pre> |
| <div class="block">INTERNAL: Returns true if this query has been created as the result of |
| cascading a delete of an aggregate collection in a UnitOfWork CR 2811</div> |
| </li> |
| </ul> |
| <a name="isDataModifyQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDataModifyQuery</h4> |
| <pre>public boolean isDataModifyQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a data modify query.</div> |
| </li> |
| </ul> |
| <a name="isDataReadQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDataReadQuery</h4> |
| <pre>public boolean isDataReadQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a data read query.</div> |
| </li> |
| </ul> |
| <a name="isValueReadQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValueReadQuery</h4> |
| <pre>public boolean isValueReadQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a value read query.</div> |
| </li> |
| </ul> |
| <a name="isDirectReadQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectReadQuery</h4> |
| <pre>public boolean isDirectReadQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a direct read query.</div> |
| </li> |
| </ul> |
| <a name="isDeleteAllQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDeleteAllQuery</h4> |
| <pre>public boolean isDeleteAllQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a delete all query.</div> |
| </li> |
| </ul> |
| <a name="isDeleteObjectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDeleteObjectQuery</h4> |
| <pre>public boolean isDeleteObjectQuery()</pre> |
| <div class="block">PUBLIC: Return if this is a delete object query.</div> |
| </li> |
| </ul> |
| <a name="isExpressionQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExpressionQuery</h4> |
| <pre>public boolean isExpressionQuery()</pre> |
| <div class="block">PUBLIC: Return true if this query uses an expression query mechanism</div> |
| </li> |
| </ul> |
| <a name="isModifyAllQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isModifyAllQuery</h4> |
| <pre>public boolean isModifyAllQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a modify all query.</div> |
| </li> |
| </ul> |
| <a name="isModifyQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isModifyQuery</h4> |
| <pre>public boolean isModifyQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a modify query.</div> |
| </li> |
| </ul> |
| <a name="isUpdateAllQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUpdateAllQuery</h4> |
| <pre>public boolean isUpdateAllQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is an update all query.</div> |
| </li> |
| </ul> |
| <a name="isUpdateObjectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUpdateObjectQuery</h4> |
| <pre>public boolean isUpdateObjectQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is an update object query.</div> |
| </li> |
| </ul> |
| <a name="getFlushOnExecute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlushOnExecute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getFlushOnExecute()</pre> |
| <div class="block">PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute |
| is true EclipseLink will write changes to the database before executing |
| the query.</div> |
| </li> |
| </ul> |
| <a name="isInsertObjectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInsertObjectQuery</h4> |
| <pre>public boolean isInsertObjectQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is an insert object query.</div> |
| </li> |
| </ul> |
| <a name="isObjectLevelModifyQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectLevelModifyQuery</h4> |
| <pre>public boolean isObjectLevelModifyQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is an object level modify query.</div> |
| </li> |
| </ul> |
| <a name="isObjectLevelReadQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectLevelReadQuery</h4> |
| <pre>public boolean isObjectLevelReadQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is an object level read query.</div> |
| </li> |
| </ul> |
| <a name="isObjectBuildingQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectBuildingQuery</h4> |
| <pre>public boolean isObjectBuildingQuery()</pre> |
| <div class="block">PUBLIC: Return if this is an object building query.</div> |
| </li> |
| </ul> |
| <a name="isPrepared--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrepared</h4> |
| <pre>public boolean isPrepared()</pre> |
| <div class="block">INTERNAL: Queries are prepared when they are executed and then do not |
| need to be prepared on subsequent executions. This method returns true if |
| this query has been prepared. Updating the settings on a query will |
| 'un-prepare' the query.</div> |
| </li> |
| </ul> |
| <a name="isReadAllQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadAllQuery</h4> |
| <pre>public boolean isReadAllQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a read all query.</div> |
| </li> |
| </ul> |
| <a name="isReadObjectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadObjectQuery</h4> |
| <pre>public boolean isReadObjectQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a read object query.</div> |
| </li> |
| </ul> |
| <a name="isReadQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadQuery</h4> |
| <pre>public boolean isReadQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a read query.</div> |
| </li> |
| </ul> |
| <a name="isReportQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReportQuery</h4> |
| <pre>public boolean isReportQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a report query.</div> |
| </li> |
| </ul> |
| <a name="isResultSetMappingQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isResultSetMappingQuery</h4> |
| <pre>public boolean isResultSetMappingQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a result set mapping query.</div> |
| </li> |
| </ul> |
| <a name="isSQLCallQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSQLCallQuery</h4> |
| <pre>public boolean isSQLCallQuery()</pre> |
| <div class="block">PUBLIC: Return true if this query uses an SQL query mechanism .</div> |
| </li> |
| </ul> |
| <a name="isJPQLCallQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isJPQLCallQuery</h4> |
| <pre>public boolean isJPQLCallQuery()</pre> |
| <div class="block">PUBLIC: Return true if this query uses an JPQL query mechanism .</div> |
| </li> |
| </ul> |
| <a name="isUserDefined--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserDefined</h4> |
| <pre>public boolean isUserDefined()</pre> |
| <div class="block">INTERNAL: Return true if the query is a custom user defined query.</div> |
| </li> |
| </ul> |
| <a name="isUserDefinedSQLCall--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserDefinedSQLCall</h4> |
| <pre>public boolean isUserDefinedSQLCall()</pre> |
| <div class="block">INTERNAL: Return true if the query is a custom user defined SQL call query.</div> |
| </li> |
| </ul> |
| <a name="isDefaultPropertiesQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultPropertiesQuery</h4> |
| <pre>public boolean isDefaultPropertiesQuery()</pre> |
| <div class="block">INTERNAL: Return true if the query uses default properties. This is used |
| to determine if this query is cacheable. i.e. does not use any properties |
| that may conflict with another query with the same EJBQL or selection |
| criteria.</div> |
| </li> |
| </ul> |
| <a name="isWriteObjectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWriteObjectQuery</h4> |
| <pre>public boolean isWriteObjectQuery()</pre> |
| <div class="block">PUBLIC: Return true if this is a write object query.</div> |
| </li> |
| </ul> |
| <a name="maintainCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maintainCache</h4> |
| <pre>public void maintainCache()</pre> |
| <div class="block">PUBLIC: Set for the identity map (cache) to be maintained. This is the |
| default.</div> |
| </li> |
| </ul> |
| <a name="prepare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre>protected void prepare() |
| throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre> |
| <div class="block">INTERNAL: This is different from 'prepareForExecution' in that this is |
| called on the original query, and the other is called on the copy of the |
| query. This query is copied for concurrency so this prepare can only |
| setup things that will apply to any future execution of this query. |
| |
| Resolve the queryTimeout using the DescriptorQueryManager if required.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFromQuery-org.eclipse.persistence.queries.DatabaseQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFromQuery</h4> |
| <pre>public void copyFromQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query)</pre> |
| <div class="block">INTERNAL: Copy all setting from the query. This is used to morph queries |
| from one type to the other. By default this calls prepareFromQuery, but |
| additional properties may be required to be copied as prepareFromQuery |
| only copies properties that affect the SQL.</div> |
| </li> |
| </ul> |
| <a name="prepareFromQuery-org.eclipse.persistence.queries.DatabaseQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareFromQuery</h4> |
| <pre>public void prepareFromQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query)</pre> |
| <div class="block">INTERNAL: Prepare the query from the prepared query. This allows a |
| dynamic query to prepare itself directly from a prepared query instance. |
| This is used in the JPQL parse cache to allow preparsed queries to be |
| used to prepare dynamic queries. This only copies over properties that |
| are configured through JPQL.</div> |
| </li> |
| </ul> |
| <a name="prepareCall-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareCall</h4> |
| <pre>public void prepareCall(<a href="../../../../org/eclipse/persistence/sessions/Session.html" title="interface in org.eclipse.persistence.sessions">Session</a> session, |
| <a href="../../../../org/eclipse/persistence/sessions/Record.html" title="interface in org.eclipse.persistence.sessions">Record</a> translationRow) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre> |
| <div class="block">ADVANCED: Pre-generate the call/SQL for the query. This method takes a |
| Session and an implementor of Record (DatebaseRow or XMLRecord). This can |
| be used to access the SQL for a query without executing it. To access the |
| call use, query.getCall(), or query.getSQLString() for the SQL. Note the |
| SQL will have argument markers in it (i.e. "?"). To translate these use |
| query.getTranslatedSQLString(session, translationRow).</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getCall--"><code>getCall()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getSQLString--"><code>getSQLString()</code></a>, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html#getTranslatedSQLString-org.eclipse.persistence.sessions.Session-org.eclipse.persistence.sessions.Record-"><code>getTranslatedSQLString(org.eclipse.persistence.sessions.Session, |
| Record)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareCustomQuery-org.eclipse.persistence.queries.DatabaseQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareCustomQuery</h4> |
| <pre>protected void prepareCustomQuery(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> customQuery)</pre> |
| <div class="block">INTERNAL: Set the properties needed to be cascaded into the custom query.</div> |
| </li> |
| </ul> |
| <a name="prepareForExecution--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareForExecution</h4> |
| <pre>public void prepareForExecution() |
| throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre> |
| <div class="block">INTERNAL: Prepare the receiver for execution in a session. In particular, |
| set the descriptor of the receiver to the ClassDescriptor for the |
| appropriate class for the receiver's object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareForRemoteExecution--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareForRemoteExecution</h4> |
| <pre>protected void prepareForRemoteExecution()</pre> |
| </li> |
| </ul> |
| <a name="redirectQuery-org.eclipse.persistence.queries.QueryRedirector-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>redirectQuery</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> redirectQuery(<a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> redirector, |
| <a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> queryToRedirect, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</pre> |
| <div class="block">INTERNAL: Use a EclipseLink redirector to redirect this query to a |
| method. Added for bug 3241138</div> |
| </li> |
| </ul> |
| <a name="remoteExecute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteExecute</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> remoteExecute()</pre> |
| </li> |
| </ul> |
| <a name="remoteExecute-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteExecute</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> remoteExecute(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="removeProperty-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeProperty</h4> |
| <pre>public void removeProperty(<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> property)</pre> |
| <div class="block">INTERNAL: Property support used by mappings.</div> |
| </li> |
| </ul> |
| <a name="replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceValueHoldersIn</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> replaceValueHoldersIn(<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> object, |
| org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)</pre> |
| <div class="block">INTERNAL: replace the value holders in the specified result object(s)</div> |
| </li> |
| </ul> |
| <a name="retrieveBypassCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>retrieveBypassCache</h4> |
| <pre>public void retrieveBypassCache()</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is retrieved by the find methods |
| and by the execution of queries. Calling this method will set a retrieve |
| bypass to true.</div> |
| </li> |
| </ul> |
| <a name="buildArgumentFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildArgumentFields</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> buildArgumentFields()</pre> |
| <div class="block">INTERNAL: Build the list of arguments fields from the argument names and |
| types.</div> |
| </li> |
| </ul> |
| <a name="rowFromArguments-java.util.List-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowFromArguments</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.AbstractRecord rowFromArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> argumentValues, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></pre> |
| <div class="block">INTERNAL: Translate argumentValues into a database row.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/QueryException.html" title="class in org.eclipse.persistence.exceptions">QueryException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAccessors-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessors</h4> |
| <pre>public void setAccessors(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.eclipse.persistence.internal.databaseaccess.Accessor> accessors)</pre> |
| <div class="block">INTERNAL: |
| Set the list of connection accessors to execute the query on.</div> |
| </li> |
| </ul> |
| <a name="setAccessor-org.eclipse.persistence.internal.databaseaccess.Accessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessor</h4> |
| <pre>public void setAccessor(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)</pre> |
| <div class="block">INTERNAL: Set the accessor, the query must always use the same accessor |
| for database access. This is required to support connection pooling.</div> |
| </li> |
| </ul> |
| <a name="setDatasourceCall-org.eclipse.persistence.queries.Call-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDatasourceCall</h4> |
| <pre>public void setDatasourceCall(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</pre> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query.</div> |
| </li> |
| </ul> |
| <a name="setCall-org.eclipse.persistence.queries.Call-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCall</h4> |
| <pre>public void setCall(<a href="../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a> call)</pre> |
| <div class="block">PUBLIC: Used to define a store procedure or SQL query.</div> |
| </li> |
| </ul> |
| <a name="setCascadePolicy-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadePolicy</h4> |
| <pre>public void setCascadePolicy(int policyConstant)</pre> |
| <div class="block">INTERNAL: Set the cascade policy.</div> |
| </li> |
| </ul> |
| <a name="setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescriptor</h4> |
| <pre>public void setDescriptor(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</pre> |
| <div class="block">INTERNAL: Set the descriptor for the query.</div> |
| </li> |
| </ul> |
| <a name="setJPQLString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJPQLString</h4> |
| <pre>public void setJPQLString(<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> jpqlString)</pre> |
| <div class="block">PUBLIC: Set the JPQL string of the query. If arguments are required in |
| the string they will be preceded by ":" then the argument name. The JPQL |
| arguments must also be added as argument to the query.</div> |
| </li> |
| </ul> |
| <a name="setEJBQLString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEJBQLString</h4> |
| <pre>public void setEJBQLString(<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> ejbqlString)</pre> |
| <div class="block">PUBLIC: Set the EJBQL string of the query. If arguments are required in |
| the string they will be preceded by "?" then the argument number.</div> |
| </li> |
| </ul> |
| <a name="setFlushOnExecute-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFlushOnExecute</h4> |
| <pre>public void setFlushOnExecute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> flushMode)</pre> |
| <div class="block">PUBLIC: If executed against a RepeatableWriteUnitOfWork if this attribute |
| is true EclipseLink will write changes to the database before executing |
| the query.</div> |
| </li> |
| </ul> |
| <a name="setHintString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHintString</h4> |
| <pre>public void setHintString(<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> newHintString)</pre> |
| <div class="block">Used to set a database hint string on the query. This should be the full |
| hint string including the comment delimiters. The hint string will be |
| generated into the SQL string after the SELECT/INSERT/UPDATE/DELETE |
| instruction. |
| <p> |
| <b>Example:</b> |
| <pre> |
| readAllQuery.setHintString("/*+ index(scott.emp ix_emp) * /"); |
| </pre> |
| would result in SQL like: |
| <pre>select /*+ index(scott.emp ix_emp) * / from scott.emp emp_alias</pre> |
| <p> |
| This method will cause a query to re-prepare if it has already been |
| executed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newHintString</code> - the hint string to be added into the SQL call.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsPrepared-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsPrepared</h4> |
| <pre>public void setIsPrepared(boolean isPrepared)</pre> |
| <div class="block">INTERNAL: If changes are made to the query that affect the derived SQL or |
| Call parameters the query needs to be prepared again. |
| <p> |
| Automatically called internally.</div> |
| </li> |
| </ul> |
| <a name="isExecutionClone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExecutionClone</h4> |
| <pre>public boolean isExecutionClone()</pre> |
| <div class="block">INTERNAL: PERF: Return if the query is an execution clone. This allow the |
| clone during execution to be avoided in the cases when the query has |
| already been clone elsewhere.</div> |
| </li> |
| </ul> |
| <a name="setIsExecutionClone-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsExecutionClone</h4> |
| <pre>public void setIsExecutionClone(boolean isExecutionClone)</pre> |
| <div class="block">INTERNAL: PERF: Set if the query is an execution clone. This allow the |
| clone during execution to be avoided in the cases when the query has |
| already been clone elsewhere.</div> |
| </li> |
| </ul> |
| <a name="isCustomQueryUsed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCustomQueryUsed</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isCustomQueryUsed()</pre> |
| <div class="block">INTERNAL: PERF: Return if this query will use the descriptor custom query |
| instead of executing itself.</div> |
| </li> |
| </ul> |
| <a name="isCustomSelectionQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCustomSelectionQuery</h4> |
| <pre>protected boolean isCustomSelectionQuery()</pre> |
| <div class="block">INTERNAL: If the query mechanism is a call query mechanism and there are |
| no arguments on the query then it must be a foreign reference custom |
| selection query.</div> |
| </li> |
| </ul> |
| <a name="setIsCustomQueryUsed-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsCustomQueryUsed</h4> |
| <pre>protected void setIsCustomQueryUsed(boolean isCustomQueryUsed)</pre> |
| <div class="block">INTERNAL: PERF: Set if this query will use the descriptor custom query |
| instead of executing itself.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isCustomQueryUsed</code> - Custom query flag as <code>boolean</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsUserDefined-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsUserDefined</h4> |
| <pre>public void setIsUserDefined(boolean isUserDefined)</pre> |
| <div class="block">INTERNAL: Set if the query is a custom user defined query.</div> |
| </li> |
| </ul> |
| <a name="setIsUserDefinedSQLCall-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsUserDefinedSQLCall</h4> |
| <pre>public void setIsUserDefinedSQLCall(boolean isUserDefinedSQLCall)</pre> |
| <div class="block">INTERNAL: Set if the query is a custom user defined sql call query.</div> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void setName(<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> queryName)</pre> |
| <div class="block">PUBLIC: Set the query's name. Queries can be named and added to a |
| descriptor or the session and then referenced by name.</div> |
| </li> |
| </ul> |
| <a name="setParameterDelimiter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setParameterDelimiter</h4> |
| <pre>public void setParameterDelimiter(<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> aParameterDelimiter)</pre> |
| <div class="block">INTERNAL: |
| Set the String char used to delimit an SQL parameter.</div> |
| </li> |
| </ul> |
| <a name="setProperties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>public void setProperties(<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>,<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>> properties)</pre> |
| <div class="block">INTERNAL: Property support used by mappings.</div> |
| </li> |
| </ul> |
| <a name="setProperty-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public void setProperty(<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> property, |
| <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">INTERNAL: Property support used by mappings to store temporary stuff.</div> |
| </li> |
| </ul> |
| <a name="setQueryMechanism-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryMechanism</h4> |
| <pre>protected void setQueryMechanism(org.eclipse.persistence.internal.queries.DatabaseQueryMechanism queryMechanism)</pre> |
| <div class="block">Set the query mechanism for the query.</div> |
| </li> |
| </ul> |
| <a name="setQueryTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeout</h4> |
| <pre>public void setQueryTimeout(int queryTimeout)</pre> |
| <div class="block">PUBLIC: Set the number of seconds the driver will wait for a Statement to |
| execute to the given number of seconds. If the limit is exceeded, a |
| DatabaseException is thrown. |
| |
| queryTimeout - the new query timeout limit in seconds; DefaultTimeout is |
| the default, which redirects to DescriptorQueryManager's queryTimeout.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/descriptors/DescriptorQueryManager.html#setQueryTimeout-int-"><code>DescriptorQueryManager.setQueryTimeout(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQueryTimeoutUnit-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryTimeoutUnit</h4> |
| <pre>public void setQueryTimeoutUnit(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> queryTimeoutUnit)</pre> |
| </li> |
| </ul> |
| <a name="setRedirector-org.eclipse.persistence.queries.QueryRedirector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRedirector</h4> |
| <pre>public void setRedirector(<a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries">QueryRedirector</a> redirector)</pre> |
| <div class="block">PUBLIC: Set the query redirector. A redirector can be used in a query to |
| replace its execution with the execution of code. This can be used for |
| named or parameterized queries to allow dynamic configuration of the |
| query base on the query arguments.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/QueryRedirector.html" title="interface in org.eclipse.persistence.queries"><code>QueryRedirector</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSelectionCriteria-org.eclipse.persistence.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSelectionCriteria</h4> |
| <pre>public void setSelectionCriteria(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> expression)</pre> |
| <div class="block">PUBLIC: To any user of this object. Set the selection criteria of the |
| query. This method be used when dealing with expressions.</div> |
| </li> |
| </ul> |
| <a name="setSession-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSession</h4> |
| <pre>public void setSession(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: Set the session for the query</div> |
| </li> |
| </ul> |
| <a name="setSessionName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionName</h4> |
| <pre>public void setSessionName(<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> sessionName)</pre> |
| <div class="block">PUBLIC: Set the name of the session that the query should be executed |
| under. This can be with the session broker to override the default |
| session.</div> |
| </li> |
| </ul> |
| <a name="setShouldBindAllParameters-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldBindAllParameters</h4> |
| <pre>public void setShouldBindAllParameters(boolean shouldBindAllParameters)</pre> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </li> |
| </ul> |
| <a name="setShouldBindAllParameters-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldBindAllParameters</h4> |
| <pre>public void setShouldBindAllParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> bindAllParams)</pre> |
| <div class="block">INTERNAL: Sets the internal tri-state value of shouldBindAllParams Used |
| to cascade this value to other queries</div> |
| </li> |
| </ul> |
| <a name="setShouldCacheStatement-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldCacheStatement</h4> |
| <pre>public void setShouldCacheStatement(boolean shouldCacheStatement)</pre> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </li> |
| </ul> |
| <a name="setShouldMaintainCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldMaintainCache</h4> |
| <pre>public void setShouldMaintainCache(boolean shouldMaintainCache)</pre> |
| <div class="block">PUBLIC: Set if the identity map (cache) should be used or not. If not the |
| cache check will be skipped and the result will not be put into the |
| identity map. By default the identity map is always maintained.</div> |
| </li> |
| </ul> |
| <a name="setShouldPrepare-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldPrepare</h4> |
| <pre>public void setShouldPrepare(boolean shouldPrepare)</pre> |
| <div class="block">PUBLIC: Set if the query should be prepared. EclipseLink automatically |
| prepares queries to generate their SQL only once, one each execution of |
| the query the SQL does not need to be generated again only the arguments |
| need to be translated. This option is provide to disable this |
| optimization as in can cause problems with certain types of queries that |
| require dynamic SQL based on their arguments. |
| <p> |
| These queries include: |
| <ul> |
| <li>Expressions that make use of 'equal' where the argument value has the |
| potential to be null, this can cause problems on databases that require |
| IS NULL, instead of = NULL. |
| <li>Expressions that make use of 'in' and that use parameter binding, |
| this will cause problems as the in values must be bound individually. |
| </ul></div> |
| </li> |
| </ul> |
| <a name="setShouldRetrieveBypassCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldRetrieveBypassCache</h4> |
| <pre>public void setShouldRetrieveBypassCache(boolean shouldRetrieveBypassCache)</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is retrieved by the find methods |
| and by the execution of queries.</div> |
| </li> |
| </ul> |
| <a name="setShouldStoreBypassCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldStoreBypassCache</h4> |
| <pre>public void setShouldStoreBypassCache(boolean shouldStoreBypassCache)</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is read from the database and when |
| data is committed into the database.</div> |
| </li> |
| </ul> |
| <a name="setShouldValidateUpdateCallCacheUse-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldValidateUpdateCallCacheUse</h4> |
| <pre>public void setShouldValidateUpdateCallCacheUse(boolean shouldCheckUpdateCallCacheUse)</pre> |
| <div class="block">INTERNAL: |
| Set if additional validation should be performed before the query uses |
| the update call cache.</div> |
| </li> |
| </ul> |
| <a name="setShouldUseWrapperPolicy-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldUseWrapperPolicy</h4> |
| <pre>public void setShouldUseWrapperPolicy(boolean shouldUseWrapperPolicy)</pre> |
| <div class="block">ADVANCED: The wrapper policy can be enable on a query.</div> |
| </li> |
| </ul> |
| <a name="setSourceMapping-org.eclipse.persistence.mappings.DatabaseMapping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceMapping</h4> |
| <pre>public void setSourceMapping(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> sourceMapping)</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="setSQLStatement-org.eclipse.persistence.internal.expressions.SQLStatement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSQLStatement</h4> |
| <pre>public void setSQLStatement(org.eclipse.persistence.internal.expressions.SQLStatement sqlStatement)</pre> |
| <div class="block">PUBLIC: To any user of this object. Set the SQL statement of the query. |
| This method should only be used when dealing with statement objects.</div> |
| </li> |
| </ul> |
| <a name="setSQLString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSQLString</h4> |
| <pre>public void setSQLString(<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> sqlString)</pre> |
| <div class="block">PUBLIC: To any user of this object. Set the SQL string of the query. This |
| method should only be used when dealing with user defined SQL strings. If |
| arguments are required in the string they will be preceded by "#" then |
| the argument name. Warning: Allowing an unverified SQL string to be |
| passed into this method makes your application vulnerable to SQL |
| injection attacks.</div> |
| </li> |
| </ul> |
| <a name="setTranslationRow-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTranslationRow</h4> |
| <pre>public void setTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)</pre> |
| <div class="block">INTERNAL: Set the row for translation</div> |
| </li> |
| </ul> |
| <a name="shouldBindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldBindAllParameters</h4> |
| <pre>public boolean shouldBindAllParameters()</pre> |
| <div class="block">PUBLIC: Bind all arguments to any SQL statement.</div> |
| </li> |
| </ul> |
| <a name="shouldAllowNativeSQLQuery-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldAllowNativeSQLQuery</h4> |
| <pre>public boolean shouldAllowNativeSQLQuery(boolean projectAllowsNativeQueries)</pre> |
| <div class="block">INTERNAL: |
| Return true if this individual query should allow native a SQL call |
| to be issued.</div> |
| </li> |
| </ul> |
| <a name="shouldCacheStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCacheStatement</h4> |
| <pre>public boolean shouldCacheStatement()</pre> |
| <div class="block">PUBLIC: Cache the prepared statements, this requires full parameter |
| binding as well.</div> |
| </li> |
| </ul> |
| <a name="shouldCascadeAllParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCascadeAllParts</h4> |
| <pre>public boolean shouldCascadeAllParts()</pre> |
| <div class="block">PUBLIC: Flag used to determine if all parts should be cascaded</div> |
| </li> |
| </ul> |
| <a name="shouldCascadeByMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCascadeByMapping</h4> |
| <pre>public boolean shouldCascadeByMapping()</pre> |
| <div class="block">PUBLIC: Mappings should be checked to determined if the current operation |
| should be cascaded to the objects referenced.</div> |
| </li> |
| </ul> |
| <a name="shouldCascadeOnlyDependentParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCascadeOnlyDependentParts</h4> |
| <pre>public boolean shouldCascadeOnlyDependentParts()</pre> |
| <div class="block">INTERNAL: Flag used for unit of works cascade policy.</div> |
| </li> |
| </ul> |
| <a name="shouldCascadeParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCascadeParts</h4> |
| <pre>public boolean shouldCascadeParts()</pre> |
| <div class="block">PUBLIC: Flag used to determine if any parts should be cascaded</div> |
| </li> |
| </ul> |
| <a name="shouldCascadePrivateParts--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCascadePrivateParts</h4> |
| <pre>public boolean shouldCascadePrivateParts()</pre> |
| <div class="block">PUBLIC: Flag used to determine if any private parts should be cascaded</div> |
| </li> |
| </ul> |
| <a name="shouldCloneCall--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldCloneCall</h4> |
| <pre>public boolean shouldCloneCall()</pre> |
| <div class="block">INTERNAL: Flag used to determine if the call needs to be cloned.</div> |
| </li> |
| </ul> |
| <a name="shouldIgnoreBindAllParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldIgnoreBindAllParameters</h4> |
| <pre>public boolean shouldIgnoreBindAllParameters()</pre> |
| <div class="block">PUBLIC: Local shouldBindAllParameters() should be ignored, Session's |
| shouldBindAllParameters() should be used.</div> |
| </li> |
| </ul> |
| <a name="shouldIgnoreCacheStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldIgnoreCacheStatement</h4> |
| <pre>public boolean shouldIgnoreCacheStatement()</pre> |
| <div class="block">PUBLIC: Local shouldCacheStatement() should be ignored, Session's |
| shouldCacheAllStatements() should be used.</div> |
| </li> |
| </ul> |
| <a name="shouldMaintainCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldMaintainCache</h4> |
| <pre>public boolean shouldMaintainCache()</pre> |
| <div class="block">PUBLIC: Return if the identity map (cache) should be used or not. If not |
| the cache check will be skipped and the result will not be put into the |
| identity map. By default the identity map is always maintained.</div> |
| </li> |
| </ul> |
| <a name="shouldPrepare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldPrepare</h4> |
| <pre>public boolean shouldPrepare()</pre> |
| <div class="block">PUBLIC: Return if the query should be prepared. EclipseLink automatically |
| prepares queries to generate their SQL only once, one each execution of |
| the query the SQL does not need to be generated again only the arguments |
| need to be translated. This option is provide to disable this |
| optimization as in can cause problems with certain types of queries that |
| require dynamic SQL based on their arguments. |
| <p> |
| These queries include: |
| <ul> |
| <li>Expressions that make use of 'equal' where the argument value has the |
| potential to be null, this can cause problems on databases that require |
| IS NULL, instead of = NULL. |
| <li>Expressions that make use of 'in' and that use parameter binding, |
| this will cause problems as the in values must be bound individually. |
| </ul></div> |
| </li> |
| </ul> |
| <a name="shouldPrepare-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldPrepare</h4> |
| <pre>public boolean shouldPrepare(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Check if the query should be prepared, or dynamic, depending on the arguments. |
| This allows null parameters to affect the SQL, such as stored procedure default values, |
| or IS NULL, or insert defaults.</div> |
| </li> |
| </ul> |
| <a name="shouldRetrieveBypassCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldRetrieveBypassCache</h4> |
| <pre>public boolean shouldRetrieveBypassCache()</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is retrieved by the find methods |
| and by the execution of queries.</div> |
| </li> |
| </ul> |
| <a name="shouldStoreBypassCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldStoreBypassCache</h4> |
| <pre>public boolean shouldStoreBypassCache()</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is read from the database and when |
| data is committed into the database.</div> |
| </li> |
| </ul> |
| <a name="shouldUseWrapperPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseWrapperPolicy</h4> |
| <pre>public boolean shouldUseWrapperPolicy()</pre> |
| <div class="block">ADVANCED: The wrapper policy can be enabled on a query.</div> |
| </li> |
| </ul> |
| <a name="shouldValidateUpdateCallCacheUse--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldValidateUpdateCallCacheUse</h4> |
| <pre>public boolean shouldValidateUpdateCallCacheUse()</pre> |
| <div class="block">ADVANCED: |
| Return true if additional validation should be performed before the query uses |
| the update call cache, false otherwise.</div> |
| </li> |
| </ul> |
| <a name="storeBypassCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>storeBypassCache</h4> |
| <pre>public void storeBypassCache()</pre> |
| <div class="block">ADVANCED: JPA flag used to control the behavior of the shared cache. This |
| flag specifies the behavior when data is read from the database and when |
| data is committed into the database. Calling this method will set a store |
| bypass to true. |
| |
| Note: For a cache store mode of REFRESH, see refreshIdentityMapResult() |
| from ObjectLevelReadQuery.</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIsNativeConnectionRequired-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsNativeConnectionRequired</h4> |
| <pre>public void setIsNativeConnectionRequired(boolean isNativeConnectionRequired)</pre> |
| <div class="block">ADVANCED: Set if the descriptor requires usage of a native (unwrapped) |
| JDBC connection. This may be required for some Oracle JDBC support when a |
| wrapping DataSource is used.</div> |
| </li> |
| </ul> |
| <a name="isNativeConnectionRequired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNativeConnectionRequired</h4> |
| <pre>public boolean isNativeConnectionRequired()</pre> |
| <div class="block">ADVANCED: Return if the descriptor requires usage of a native (unwrapped) |
| JDBC connection. This may be required for some Oracle JDBC support when a |
| wrapping DataSource is used.</div> |
| </li> |
| </ul> |
| <a name="getDoNotRedirect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoNotRedirect</h4> |
| <pre>public boolean getDoNotRedirect()</pre> |
| <div class="block">This method is used in combination with redirected queries. If a |
| redirector is set on the query or there is a default redirector on the |
| Descriptor setting this value to true will force EclipseLink to ignore |
| the redirector during execution. This setting will be used most often |
| when reexecuting the query within a redirector.</div> |
| </li> |
| </ul> |
| <a name="setDoNotRedirect-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDoNotRedirect</h4> |
| <pre>public void setDoNotRedirect(boolean doNotRedirect)</pre> |
| <div class="block">This method is used in combination with redirected queries. If a |
| redirector is set on the query or there is a default redirector on the |
| Descriptor setting this value to true will force EclipseLink to ignore |
| the redirector during execution. This setting will be used most often |
| when reexecuting the query within a redirector.</div> |
| </li> |
| </ul> |
| <a name="getBatchObjects--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchObjects</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>,<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>> getBatchObjects()</pre> |
| <div class="block">INTERNAL: |
| Return temporary map of batched objects.</div> |
| </li> |
| </ul> |
| <a name="setBatchObjects-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBatchObjects</h4> |
| <pre>public void setBatchObjects(<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>,<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>> batchObjects)</pre> |
| <div class="block">INTERNAL: |
| Set temporary map of batched objects.</div> |
| </li> |
| </ul> |
| <a name="setAllowNativeSQLQuery-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAllowNativeSQLQuery</h4> |
| <pre>public void setAllowNativeSQLQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> allowNativeSQLQuery)</pre> |
| <div class="block">INTERNAL: |
| Set to true if this individual query should be marked to bypass a |
| persistence unit level disallow SQL queries flag.</div> |
| </li> |
| </ul> |
| <a name="hasNullableArguments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNullableArguments</h4> |
| <pre>public boolean hasNullableArguments()</pre> |
| <div class="block">INTERNAL: |
| Return if the query has any nullable arguments.</div> |
| </li> |
| </ul> |
| <a name="getNullableArguments--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullableArguments</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> getNullableArguments()</pre> |
| <div class="block">INTERNAL: |
| Return the list of arguments to check for null. |
| If any are null, the query needs to be re-prepared.</div> |
| </li> |
| </ul> |
| <a name="setNullableArguments-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setNullableArguments</h4> |
| <pre>public void setNullableArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.eclipse.persistence.internal.helper.DatabaseField> nullableArguments)</pre> |
| <div class="block">INTERNAL: |
| Set the list of arguments to check for null. |
| If any are null, the query needs to be re-prepared.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/queries/CursorPolicy.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.ParameterType.html" title="enum in org.eclipse.persistence.queries"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/queries/DatabaseQuery.html" target="_top">Frames</a></li> |
| <li><a href="DatabaseQuery.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><a href="#nested.class.summary">Nested</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |