| <!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 Thu Apr 08 02:07:33 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Call (EclipseLink 3.0.1, API Reference)</title> |
| <meta name="date" content="2021-04-08"> |
| <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="Call (EclipseLink 3.0.1, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/queries/BatchFetchPolicy.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/ColumnResult.html" title="class 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/Call.html" target="_top">Frames</a></li> |
| <li><a href="Call.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface Call" class="title">Interface Call</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd>org.eclipse.persistence.internal.databaseaccess.DatabaseCall, org.eclipse.persistence.internal.databaseaccess.DatasourceCall, <a href="../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">EISInteraction</a>, <a href="../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">IndexedInteraction</a>, <a href="../../../../org/eclipse/persistence/queries/JPQLCall.html" title="class in org.eclipse.persistence.queries">JPQLCall</a>, <a href="../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">MappedInteraction</a>, <a href="../../../../org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredFunctionCall.html" title="class in org.eclipse.persistence.platform.database.oracle.plsql">PLSQLStoredFunctionCall</a>, <a href="../../../../org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredProcedureCall.html" title="class in org.eclipse.persistence.platform.database.oracle.plsql">PLSQLStoredProcedureCall</a>, <a href="../../../../org/eclipse/persistence/eis/interactions/QueryStringInteraction.html" title="class in org.eclipse.persistence.eis.interactions">QueryStringInteraction</a>, <a href="../../../../org/eclipse/persistence/queries/SQLCall.html" title="class in org.eclipse.persistence.queries">SQLCall</a>, <a href="../../../../org/eclipse/persistence/queries/StoredFunctionCall.html" title="class in org.eclipse.persistence.queries">StoredFunctionCall</a>, <a href="../../../../org/eclipse/persistence/queries/StoredProcedureCall.html" title="class in org.eclipse.persistence.queries">StoredProcedureCall</a>, <a href="../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a>, <a href="../../../../org/eclipse/persistence/eis/interactions/XQueryInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XQueryInteraction</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Call</span> |
| extends <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">Call defines the interface used primarily by EclipseLink queries |
| and query mechanisms to perform the necessary actions |
| (read, insert, update, delete) on the data store. |
| A Call can collaborate with an Accessor to perform its |
| responsibilities. The only explicit requirement of a Call is that |
| it be able to supply the appropriate query mechanism for |
| performing its duties. Otherwise, the Call is pretty much |
| unrestricted as to how it should perform its responsibilities.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries"><code>DatabaseQuery</code></a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Big Country</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TOPLink/Java 3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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></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>org.eclipse.persistence.internal.queries.DatabaseQueryMechanism</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Call.html#buildNewQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-">buildNewQueryMechanism</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: |
| Return the appropriate mechanism, |
| with the call set as necessary.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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/Call.html#buildQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-">buildQueryMechanism</a></span>(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| org.eclipse.persistence.internal.queries.DatabaseQueryMechanism mechanism)</code> |
| <div class="block">INTERNAL: |
| Return the appropriate mechanism, |
| with the call added as necessary.</div> |
| </td> |
| </tr> |
| <tr id="i2" 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/Call.html#clone--">clone</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return a clone of the call.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/Call.html#getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">getLogString</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)</code> |
| <div class="block">INTERNAL: |
| Return a string appropriate for the session log.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Call.html#isFinished--">isFinished</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return whether the call is finished returning |
| all of its results (e.g.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Call.html#isNothingReturned--">isNothingReturned</a></span>()</code> |
| <div class="block">The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/Call.html#isOneRowReturned--">isOneRowReturned</a></span>()</code> |
| <div class="block">The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="buildNewQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildNewQueryMechanism</h4> |
| <pre>org.eclipse.persistence.internal.queries.DatabaseQueryMechanism buildNewQueryMechanism(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| Return the appropriate mechanism, |
| with the call set as necessary.</div> |
| </li> |
| </ul> |
| <a name="buildQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildQueryMechanism</h4> |
| <pre>org.eclipse.persistence.internal.queries.DatabaseQueryMechanism buildQueryMechanism(<a href="../../../../org/eclipse/persistence/queries/DatabaseQuery.html" title="class in org.eclipse.persistence.queries">DatabaseQuery</a> query, |
| org.eclipse.persistence.internal.queries.DatabaseQueryMechanism mechanism)</pre> |
| <div class="block">INTERNAL: |
| Return the appropriate mechanism, |
| with the call added as necessary.</div> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone()</pre> |
| <div class="block">INTERNAL: |
| Return a clone of the call.</div> |
| </li> |
| </ul> |
| <a name="getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogString</h4> |
| <pre><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> getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)</pre> |
| <div class="block">INTERNAL: |
| Return a string appropriate for the session log.</div> |
| </li> |
| </ul> |
| <a name="isFinished--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFinished</h4> |
| <pre>boolean isFinished()</pre> |
| <div class="block">INTERNAL: |
| Return whether the call is finished returning |
| all of its results (e.g. a call that returns a cursor |
| will answer false).</div> |
| </li> |
| </ul> |
| <a name="isNothingReturned--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNothingReturned</h4> |
| <pre>boolean isNothingReturned()</pre> |
| <div class="block">The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.</div> |
| </li> |
| </ul> |
| <a name="isOneRowReturned--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isOneRowReturned</h4> |
| <pre>boolean isOneRowReturned()</pre> |
| <div class="block">The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.</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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/queries/BatchFetchPolicy.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/ColumnResult.html" title="class 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/Call.html" target="_top">Frames</a></li> |
| <li><a href="Call.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
