blob: 681664a9607af0f7175a4ac0b1136a1f0870277b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:56 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XQueryInteraction (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="XQueryInteraction (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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/eis/interactions/XQueryInteraction.html" target="_top">Frames</a></li>
<li><a href="XQueryInteraction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.eis.interactions</div>
<h2 title="Class XQueryInteraction" class="title">Class XQueryInteraction</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.internal.databaseaccess.DatasourceCall</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">org.eclipse.persistence.eis.interactions.EISInteraction</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">org.eclipse.persistence.eis.interactions.MappedInteraction</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">org.eclipse.persistence.eis.interactions.XMLInteraction</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.eis.interactions.XQueryInteraction</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/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>, org.eclipse.persistence.internal.databaseaccess.QueryStringCall, <a href="../../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">XQueryInteraction</span>
extends <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a>
implements org.eclipse.persistence.internal.databaseaccess.QueryStringCall</pre>
<div class="block">Defines the specification for a call to a JCA interaction that uses XQuery.
Translates the XQuery from the query arguments.
Builds the input and output XML records.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.eis.interactions.XQueryInteraction">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>James</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>OracleAS TopLink 10<i>g</i> (10.0.3)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>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/eis/interactions/XQueryInteraction.html#xQueryString">xQueryString</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.eis.interactions.XMLInteraction">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#inputRootElementName">inputRootElementName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#outputRootElementName">outputRootElementName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.eis.interactions.MappedInteraction">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">MappedInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#argumentNames">argumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#inputResultPath">inputResultPath</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.eis.interactions.EISInteraction">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">EISInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#arguments">arguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#functionName">functionName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#inputRecordName">inputRecordName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#inputRow">inputRow</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#interactionSpec">interactionSpec</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#outputArgumentNames">outputArgumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#outputArguments">outputArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#outputResultPath">outputResultPath</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#properties">properties</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.internal.databaseaccess.DatasourceCall">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.internal.databaseaccess.DatasourceCall</h3>
<code>CUSTOM_MODIFY, EXECUTE_UPDATE, IN, INLINE, INOUT, isNativeConnectionRequired, isPrepared, LITERAL, MODIFY, NO_RETURN, OUT, OUT_CURSOR, parameters, parameterTypes, query, RETURN_CURSOR, RETURN_MANY_ROWS, RETURN_ONE_ROW, returnType, shouldProcessTokenInQuotes, TRANSLATION</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/XQueryInteraction.html#XQueryInteraction--">XQueryInteraction</a></span>()</code>
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/XQueryInteraction.html#XQueryInteraction-java.lang.String-">XQueryInteraction</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>&nbsp;xQueryString)</code>
<div class="block">Construct the interaction with the XQuery string.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/XQueryInteraction.html#argumentMarker--">argumentMarker</a></span>()</code>
<div class="block">INTERNAL:
Return the character to use for the argument marker.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/XQueryInteraction.html#createInputDOM-org.eclipse.persistence.eis.EISAccessor-">createInputDOM</a></span>(<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</code>
<div class="block">Create a DOM for this interaction.</div>
</td>
</tr>
<tr id="i2" 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/eis/interactions/XQueryInteraction.html#getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">getLogString</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor)</code>
<div class="block">Return the string for logging purposes.</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/eis/interactions/XQueryInteraction.html#getQueryString--">getQueryString</a></span>()</code>
<div class="block">INTERNAL:
Return the query string.</div>
</td>
</tr>
<tr id="i4" 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/eis/interactions/XQueryInteraction.html#getXQueryString--">getXQueryString</a></span>()</code>
<div class="block">PUBLIC:
Return the XQuery string.</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/eis/interactions/XQueryInteraction.html#isQueryStringCall--">isQueryStringCall</a></span>()</code>
<div class="block">Should return true.</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/eis/interactions/XQueryInteraction.html#prepare-org.eclipse.persistence.internal.sessions.AbstractSession-">prepare</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Translate the custom query markers.</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/eis/interactions/XQueryInteraction.html#setQueryString-java.lang.String-">setQueryString</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>&nbsp;queryString)</code>
<div class="block">INTERNAL:
Set the query string.</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/eis/interactions/XQueryInteraction.html#setXQueryString-java.lang.String-">setXQueryString</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>&nbsp;xQueryString)</code>
<div class="block">PUBLIC:
Set the XQuery string.</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/eis/interactions/XQueryInteraction.html#translate-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">translate</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;translationRow,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;modifyRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Allow the call to translate the XQuery arguments.</div>
</td>
</tr>
<tr id="i10" 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/eis/interactions/XQueryInteraction.html#whitespace--">whitespace</a></span>()</code>
<div class="block">INTERNAL:
Return the characters that represent non-arguments names.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.eis.interactions.XMLInteraction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#buildRow-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRow</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#buildRows-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRows</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#createField-java.lang.String-">createField</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#createInputRecord-org.eclipse.persistence.eis.EISAccessor-">createInputRecord</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#createXMLRecord-java.lang.String-">createXMLRecord</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#getInputRootElementName--">getInputRootElementName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#getOutputRootElementName--">getOutputRootElementName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#setInputRootElementName-java.lang.String-">setInputRootElementName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#setOutputRootElementName-java.lang.String-">setOutputRootElementName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.eis.interactions.MappedInteraction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">MappedInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#addArgument-java.lang.String-">addArgument</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#addArgument-java.lang.String-java.lang.String-">addArgument</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#addArgumentValue-java.lang.String-java.lang.Object-">addArgumentValue</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#createTranslationRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.eis.EISAccessor-">createTranslationRecord</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#getArgumentNames--">getArgumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#getInputResultPath--">getInputResultPath</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#setArgumentNames-java.util.Vector-">setArgumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html#setInputResultPath-java.lang.String-">setInputResultPath</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.eis.interactions.EISInteraction">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.eis.interactions.<a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">EISInteraction</a></h3>
<code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#addOutputArgument-java.lang.String-">addOutputArgument</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#addOutputArgument-java.lang.String-java.lang.String-">addOutputArgument</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#createRecordElement-java.lang.String-java.lang.Object-org.eclipse.persistence.eis.EISAccessor-">createRecordElement</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getArguments--">getArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getFunctionName--">getFunctionName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getInputRecordName--">getInputRecordName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getInputRow--">getInputRow</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getInteractionSpec--">getInteractionSpec</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArgumentNames--">getOutputArgumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArguments--">getOutputArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputResultPath--">getOutputResultPath</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getProperties--">getProperties</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getProperty-java.lang.String-">getProperty</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#hasArguments--">hasArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#hasOutputArguments--">hasOutputArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#isEISInteraction--">isEISInteraction</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setArguments-java.util.Vector-">setArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setFunctionName-java.lang.String-">setFunctionName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setInputRecordName-java.lang.String-">setInputRecordName</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setInputRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setInputRow</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setInteractionSpec-jakarta.resource.cci.InteractionSpec-">setInteractionSpec</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setOutputArgumentNames-java.util.Vector-">setOutputArgumentNames</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setOutputArguments-java.util.Vector-">setOutputArguments</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setOutputResultPath-java.lang.String-">setOutputResultPath</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setProperties-java.util.Map-">setProperties</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.databaseaccess.DatasourceCall">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.internal.databaseaccess.DatasourceCall</h3>
<code>appendIn, appendInOut, appendLiteral, appendModify, appendOut, appendParameter, appendTranslation, areManyRowsReturned, buildNewQueryMechanism, buildQueryMechanism, clone, createInOutParameter, getParameters, getParameterTypes, getQuery, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.internal.databaseaccess.QueryStringCall">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.persistence.internal.databaseaccess.QueryStringCall</h3>
<code>appendLiteral, appendModify, appendParameter, appendTranslation, getParameters, getParameterTypes, hasParameters, translateCustomQuery, translateQueryString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.queries.Call">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.persistence.queries.<a href="../../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a></h3>
<code><a href="../../../../../org/eclipse/persistence/queries/Call.html#buildNewQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-">buildNewQueryMechanism</a>, <a href="../../../../../org/eclipse/persistence/queries/Call.html#buildQueryMechanism-org.eclipse.persistence.queries.DatabaseQuery-org.eclipse.persistence.internal.queries.DatabaseQueryMechanism-">buildQueryMechanism</a>, <a href="../../../../../org/eclipse/persistence/queries/Call.html#clone--">clone</a>, <a href="../../../../../org/eclipse/persistence/queries/Call.html#isFinished--">isFinished</a>, <a href="../../../../../org/eclipse/persistence/queries/Call.html#isNothingReturned--">isNothingReturned</a>, <a href="../../../../../org/eclipse/persistence/queries/Call.html#isOneRowReturned--">isOneRowReturned</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="xQueryString">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>xQueryString</h4>
<pre>protected&nbsp;<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> xQueryString</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XQueryInteraction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XQueryInteraction</h4>
<pre>public&nbsp;XQueryInteraction()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a name="XQueryInteraction-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XQueryInteraction</h4>
<pre>public&nbsp;XQueryInteraction(<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>&nbsp;xQueryString)</pre>
<div class="block">Construct the interaction with the XQuery string.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getXQueryString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXQueryString</h4>
<pre>public&nbsp;<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>&nbsp;getXQueryString()</pre>
<div class="block">PUBLIC:
Return the XQuery string.</div>
</li>
</ul>
<a name="setXQueryString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setXQueryString</h4>
<pre>public&nbsp;void&nbsp;setXQueryString(<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>&nbsp;xQueryString)</pre>
<div class="block">PUBLIC:
Set the XQuery string.</div>
</li>
</ul>
<a name="getQueryString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryString</h4>
<pre>public&nbsp;<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>&nbsp;getQueryString()</pre>
<div class="block">INTERNAL:
Return the query string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getQueryString</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getQueryString</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="setQueryString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryString</h4>
<pre>public&nbsp;void&nbsp;setQueryString(<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>&nbsp;queryString)</pre>
<div class="block">INTERNAL:
Set the query string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setQueryString</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setQueryString</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="translate-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translate</h4>
<pre>public&nbsp;void&nbsp;translate(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;translationRow,
org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;modifyRow,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Allow the call to translate the XQuery arguments.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>translate</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#translate-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">translate</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">EISInteraction</a></code></dd>
</dl>
</li>
</ul>
<a name="createInputDOM-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInputDOM</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a>&nbsp;createInputDOM(<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</pre>
<div class="block">Create a DOM for this interaction.
Convert the database row or arguments into an XML DOM tree.
Handles arguments different as the XQuery and input can both have parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#createInputDOM-org.eclipse.persistence.eis.EISAccessor-">createInputDOM</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a></code></dd>
</dl>
</li>
</ul>
<a name="prepare-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;void&nbsp;prepare(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Translate the custom query markers.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>prepare</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#prepare-org.eclipse.persistence.internal.sessions.AbstractSession-">prepare</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a></code></dd>
</dl>
</li>
</ul>
<a name="getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogString</h4>
<pre>public&nbsp;<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>&nbsp;getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor)</pre>
<div class="block">Return the string for logging purposes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/queries/Call.html#getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">getLogString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html#getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">getLogString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/persistence/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions">XMLInteraction</a></code></dd>
</dl>
</li>
</ul>
<a name="argumentMarker--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>argumentMarker</h4>
<pre>protected&nbsp;char&nbsp;argumentMarker()</pre>
<div class="block">INTERNAL:
Return the character to use for the argument marker.
? is used in SQL, however other query languages such as XQuery need to use other markers.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>argumentMarker</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="whitespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>whitespace</h4>
<pre>protected&nbsp;<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>&nbsp;whitespace()</pre>
<div class="block">INTERNAL:
Return the characters that represent non-arguments names.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>whitespace</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="isQueryStringCall--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isQueryStringCall</h4>
<pre>public&nbsp;boolean&nbsp;isQueryStringCall()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></span></div>
<div class="block">Should return true.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isQueryStringCall</code>&nbsp;in interface&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.QueryStringCall</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>isQueryStringCall</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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/eis/interactions/XMLInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/eis/interactions/XQueryInteraction.html" target="_top">Frames</a></li>
<li><a href="XQueryInteraction.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>