blob: 93d02e7d754e8d878ac4872cc00b1fbd9fe63079 [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:55 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EISInteraction (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="EISInteraction (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/eis/interactions/EISInteraction.html" target="_top">Frames</a></li>
<li><a href="EISInteraction.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 EISInteraction" class="title">Class EISInteraction</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>org.eclipse.persistence.eis.interactions.EISInteraction</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>, <a href="../../../../../org/eclipse/persistence/queries/Call.html" title="interface in org.eclipse.persistence.queries">Call</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">IndexedInteraction</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.html" title="class in org.eclipse.persistence.eis.interactions">MappedInteraction</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">EISInteraction</span>
extends org.eclipse.persistence.internal.databaseaccess.DatasourceCall</pre>
<div class="block">Defines the specification for a call to a JCA interaction.
Builds the input and output records from the arguments.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.eis.interactions.EISInteraction">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/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#arguments">arguments</a></span></code>
<div class="block">Defines the arguments to the interaction, these can be the values or argument names/fields the values come from.</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/eis/interactions/EISInteraction.html#functionName">functionName</a></span></code>
<div class="block">Name of the function the interaction describes.</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/eis/interactions/EISInteraction.html#inputRecordName">inputRecordName</a></span></code>
<div class="block">Name to pass to the input record creation.</div>
</td>
</tr>
<tr class="rowColor">
<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/eis/interactions/EISInteraction.html#inputRow">inputRow</a></span></code>
<div class="block">Holds database row of input values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected jakarta.resource.cci.InteractionSpec</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#interactionSpec">interactionSpec</a></span></code>
<div class="block">Adapter specific interaction spec.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#outputArgumentNames">outputArgumentNames</a></span></code>
<div class="block">Defines the output argument names as defined in the output record for the interaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#outputArguments">outputArguments</a></span></code>
<div class="block">Defines the field values the output arguments of the interaction map to.</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/eis/interactions/EISInteraction.html#outputResultPath">outputResultPath</a></span></code>
<div class="block">Path to the desired output record if nested.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#properties">properties</a></span></code>
<div class="block">Adapter specific properties may be added.</div>
</td>
</tr>
</table>
<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/EISInteraction.html#EISInteraction--">EISInteraction</a></span>()</code>
<div class="block">PUBLIC:
Default constructor.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#addOutputArgument-java.lang.String-">addOutputArgument</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;parameterAndArgumentFieldName)</code>
<div class="block">PUBLIC:
Define the output argument to the interaction and the field/argument name to be substitute for it.</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/eis/interactions/EISInteraction.html#addOutputArgument-java.lang.String-java.lang.String-">addOutputArgument</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;parameterName,
<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;argumentFieldName)</code>
<div class="block">PUBLIC:
Define the output argument to the interaction and the field/argument name to be substitute for it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract org.eclipse.persistence.internal.sessions.AbstractRecord</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#buildRow-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRow</a></span>(jakarta.resource.cci.Record&nbsp;record,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</code>
<div class="block">INTERNAL:
Build a database row from the record returned from the interaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#buildRows-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRows</a></span>(jakarta.resource.cci.Record&nbsp;record,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</code>
<div class="block">Build a collection of database rows from the Record returned from the interaction.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract jakarta.resource.cci.Record</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#createInputRecord-org.eclipse.persistence.eis.EISAccessor-">createInputRecord</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 the appropriate input record for this interaction.</div>
</td>
</tr>
<tr id="i5" 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/eis/interactions/EISInteraction.html#createRecordElement-java.lang.String-java.lang.Object-org.eclipse.persistence.eis.EISAccessor-">createRecordElement</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;elementName,
<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>&nbsp;value,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</code>
<div class="block">Create the appropriate record element for the data value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getArguments--">getArguments</a></span>()</code>
<div class="block">The argument fields or values to the interaction that map into the input record.</div>
</td>
</tr>
<tr id="i7" 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/EISInteraction.html#getFunctionName--">getFunctionName</a></span>()</code>
<div class="block">PUBLIC:
Return the function name of the interaction.</div>
</td>
</tr>
<tr id="i8" 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/EISInteraction.html#getInputRecordName--">getInputRecordName</a></span>()</code>
<div class="block">PUBLIC:
Return the input record name.</div>
</td>
</tr>
<tr id="i9" 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/eis/interactions/EISInteraction.html#getInputRow--">getInputRow</a></span>()</code>
<div class="block">INTERNAL:
Return the input database row.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>jakarta.resource.cci.InteractionSpec</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getInteractionSpec--">getInteractionSpec</a></span>()</code>
<div class="block">PUBLIC:
Return the JCA InteractionSpec that defines this EIS interaction.</div>
</td>
</tr>
<tr id="i11" 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/EISInteraction.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="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArgumentNames--">getOutputArgumentNames</a></span>()</code>
<div class="block">The argument names for the output record.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArguments--">getOutputArguments</a></span>()</code>
<div class="block">The argument fields to the interaction that map into the output record.</div>
</td>
</tr>
<tr id="i14" 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/EISInteraction.html#getOutputResultPath--">getOutputResultPath</a></span>()</code>
<div class="block">PUBLIC:
The output result path defines the root key for the MappedRecord that
the desired interaction result is nested into.</div>
</td>
</tr>
<tr id="i15" 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/eis/interactions/EISInteraction.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Returns the adapter specific properties.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getProperty-java.lang.String-">getProperty</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;name)</code>
<div class="block">PUBLIC:
Returns the adapter property associated the given name.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#hasArguments--">hasArguments</a></span>()</code>
<div class="block">Return if argumented.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#hasOutputArguments--">hasOutputArguments</a></span>()</code>
<div class="block">Return if argumented.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#isEISInteraction--">isEISInteraction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#prepare-org.eclipse.persistence.internal.sessions.AbstractSession-">prepare</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">Set the default record name from the descriptor.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setArguments-java.util.Vector-">setArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;arguments)</code>
<div class="block">INTERNAL:
The argument fields or values to the interaction that map into the input record.</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/eis/interactions/EISInteraction.html#setFunctionName-java.lang.String-">setFunctionName</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;functionName)</code>
<div class="block">PUBLIC:
Set the function name of the interaction.</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/eis/interactions/EISInteraction.html#setInputRecordName-java.lang.String-">setInputRecordName</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;recordName)</code>
<div class="block">PUBLIC:
Set the input record name.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setInputRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">setInputRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;inputRow)</code>
<div class="block">PUBLIC:
Set the input database row.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setInteractionSpec-jakarta.resource.cci.InteractionSpec-">setInteractionSpec</a></span>(jakarta.resource.cci.InteractionSpec&nbsp;interactionSpec)</code>
<div class="block">PUBLIC:
Set the JCA InteractionSpec that defines this EIS interaction.</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/eis/interactions/EISInteraction.html#setOutputArgumentNames-java.util.Vector-">setOutputArgumentNames</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;outputArgumentNames)</code>
<div class="block">Set the output argument names.</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/eis/interactions/EISInteraction.html#setOutputArguments-java.util.Vector-">setOutputArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;outputArguments)</code>
<div class="block">The output arguments.</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/eis/interactions/EISInteraction.html#setOutputResultPath-java.lang.String-">setOutputResultPath</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;outputResultPath)</code>
<div class="block">PUBLIC:
The output result path defines the root key for the MappedRecord that
the desired interaction result is nested into.</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/eis/interactions/EISInteraction.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>&nbsp;properties)</code>
<div class="block">Set the adapter specific properties.</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/eis/interactions/EISInteraction.html#setProperty-java.lang.String-java.lang.Object-">setProperty</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;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">PUBLIC:
Set the adapter specific property.</div>
</td>
</tr>
<tr id="i31" 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/EISInteraction.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/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></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">Arguments to the interaction can be passed two ways.</div>
</td>
</tr>
</table>
<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, argumentMarker, buildNewQueryMechanism, buildQueryMechanism, clone, createField, createInOutParameter, getParameters, getParameterTypes, getQuery, getQueryString, getReturnType, getValueForInOutParameter, getValueForInParameter, hasParameters, isCursorReturned, isExecuteUpdate, isFinished, isJPQLCall, isNativeConnectionRequired, isNothingReturned, isOneRowReturned, isOutputParameterType, isPrepared, isQueryStringCall, isReturnSet, isSQLCall, isStoredFunctionCall, isStoredPLSQLFunctionCall, isStoredPLSQLProcedureCall, isStoredProcedureCall, returnCursor, returnManyRows, returnNothing, returnOneRow, setExecuteUpdate, setIsNativeConnectionRequired, setIsPrepared, setParameters, setParameterTypes, setQuery, setQueryString, setReturnType, translateCustomQuery, translatePureSQLCustomQuery, translateQueryString, whitespace</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>
</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="interactionSpec">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interactionSpec</h4>
<pre>protected&nbsp;jakarta.resource.cci.InteractionSpec interactionSpec</pre>
<div class="block">Adapter specific interaction spec.</div>
</li>
</ul>
<a name="functionName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>functionName</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> functionName</pre>
<div class="block">Name of the function the interaction describes.</div>
</li>
</ul>
<a name="inputRecordName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputRecordName</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> inputRecordName</pre>
<div class="block">Name to pass to the input record creation.</div>
</li>
</ul>
<a name="properties">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre>protected&nbsp;<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> properties</pre>
<div class="block">Adapter specific properties may be added.</div>
</li>
</ul>
<a name="inputRow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputRow</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord inputRow</pre>
<div class="block">Holds database row of input values.</div>
</li>
</ul>
<a name="arguments">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arguments</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> arguments</pre>
<div class="block">Defines the arguments to the interaction, these can be the values or argument names/fields the values come from.</div>
</li>
</ul>
<a name="outputArgumentNames">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputArgumentNames</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> outputArgumentNames</pre>
<div class="block">Defines the output argument names as defined in the output record for the interaction.
This is shared as indexed interaction may still have mapped results.</div>
</li>
</ul>
<a name="outputArguments">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>outputArguments</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> outputArguments</pre>
<div class="block">Defines the field values the output arguments of the interaction map to. These are order dependent with the names.</div>
</li>
</ul>
<a name="outputResultPath">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>outputResultPath</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> outputResultPath</pre>
<div class="block">Path to the desired output record if nested.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EISInteraction--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EISInteraction</h4>
<pre>public&nbsp;EISInteraction()</pre>
<div class="block">PUBLIC:
Default constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addOutputArgument-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOutputArgument</h4>
<pre>public&nbsp;void&nbsp;addOutputArgument(<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;parameterAndArgumentFieldName)</pre>
<div class="block">PUBLIC:
Define the output argument to the interaction and the field/argument name to be substitute for it.
This is only required if an output row is not used.
The parameterAndArgumentFieldName is the name of the output record argument expected,
and is the field or argument name to be used to be used for it.
These names are assumed to be the same, if not this method can be called with two arguments.</div>
</li>
</ul>
<a name="addOutputArgument-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOutputArgument</h4>
<pre>public&nbsp;void&nbsp;addOutputArgument(<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;parameterName,
<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;argumentFieldName)</pre>
<div class="block">PUBLIC:
Define the output argument to the interaction and the field/argument name to be substitute for it.
This is only required if an output row is not used.
The parameterName is the name of the output record argument expected.
The argumentFieldName is the field or argument name to be used to be used for it.
If these names are the same (as they normally are) this method can be called with a single argument.</div>
</li>
</ul>
<a name="getArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArguments</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getArguments()</pre>
<div class="block">The argument fields or values to the interaction that map into the input record.</div>
</li>
</ul>
<a name="setArguments-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setArguments</h4>
<pre>public&nbsp;void&nbsp;setArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;arguments)</pre>
<div class="block">INTERNAL:
The argument fields or values to the interaction that map into the input record.</div>
</li>
</ul>
<a name="hasArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasArguments</h4>
<pre>public&nbsp;boolean&nbsp;hasArguments()</pre>
<div class="block">Return if argumented.</div>
</li>
</ul>
<a name="isEISInteraction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEISInteraction</h4>
<pre>public&nbsp;boolean&nbsp;isEISInteraction()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>isEISInteraction</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="getOutputResultPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputResultPath</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;getOutputResultPath()</pre>
<div class="block">PUBLIC:
The output result path defines the root key for the MappedRecord that
the desired interaction result is nested into.
This is required for read interactions that need a nested record to build from the mapped object.</div>
</li>
</ul>
<a name="setOutputResultPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputResultPath</h4>
<pre>public&nbsp;void&nbsp;setOutputResultPath(<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;outputResultPath)</pre>
<div class="block">PUBLIC:
The output result path defines the root key for the MappedRecord that
the desired interaction result is nested into.
This is required for read interactions that need a nested record to build from the mapped object.</div>
</li>
</ul>
<a name="getOutputArgumentNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputArgumentNames</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getOutputArgumentNames()</pre>
<div class="block">The argument names for the output record.</div>
</li>
</ul>
<a name="getOutputArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputArguments</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getOutputArguments()</pre>
<div class="block">The argument fields to the interaction that map into the output record.</div>
</li>
</ul>
<a name="setOutputArguments-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputArguments</h4>
<pre>public&nbsp;void&nbsp;setOutputArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;outputArguments)</pre>
<div class="block">The output arguments.</div>
</li>
</ul>
<a name="setOutputArgumentNames-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputArgumentNames</h4>
<pre>public&nbsp;void&nbsp;setOutputArgumentNames(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;outputArgumentNames)</pre>
<div class="block">Set the output argument names.</div>
</li>
</ul>
<a name="hasOutputArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasOutputArguments</h4>
<pre>public&nbsp;boolean&nbsp;hasOutputArguments()</pre>
<div class="block">Return if argumented.</div>
</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">Set the default record name from the descriptor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>prepare</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="createRecordElement-java.lang.String-java.lang.Object-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRecordElement</h4>
<pre>public&nbsp;<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>&nbsp;createRecordElement(<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;elementName,
<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>&nbsp;value,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</pre>
<div class="block">Create the appropriate record element for the data value.
If the value is a collection, create a collection of elements,
if the value is a map, create a nested map,
otherwise just return the value (primitive data).</div>
</li>
</ul>
<a name="getInteractionSpec--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInteractionSpec</h4>
<pre>public&nbsp;jakarta.resource.cci.InteractionSpec&nbsp;getInteractionSpec()</pre>
<div class="block">PUBLIC:
Return the JCA InteractionSpec that defines this EIS interaction.
The InteractionSpec is JCA adapter specific and typically
defines the function name.</div>
</li>
</ul>
<a name="setInteractionSpec-jakarta.resource.cci.InteractionSpec-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInteractionSpec</h4>
<pre>public&nbsp;void&nbsp;setInteractionSpec(jakarta.resource.cci.InteractionSpec&nbsp;interactionSpec)</pre>
<div class="block">PUBLIC:
Set the JCA InteractionSpec that defines this EIS interaction.
The InteractionSpec is JCA adapter specific and typically
defines the function name.</div>
</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">Specified by:</span></dt>
<dd><code>getLogString</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">Arguments to the interaction can be passed two ways.
The entire argument row can be converted to the input record,
or the arguments from the row can be translated into the interaction parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>translate</code>&nbsp;in class&nbsp;<code>org.eclipse.persistence.internal.databaseaccess.DatasourceCall</code></dd>
</dl>
</li>
</ul>
<a name="createInputRecord-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInputRecord</h4>
<pre>public abstract&nbsp;jakarta.resource.cci.Record&nbsp;createInputRecord(<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</pre>
<div class="block">Create the appropriate input record for this interaction.
Populate the data into the record from this interaction's arguments.</div>
</li>
</ul>
<a name="buildRow-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildRow</h4>
<pre>public abstract&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;buildRow(jakarta.resource.cci.Record&nbsp;record,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</pre>
<div class="block">INTERNAL:
Build a database row from the record returned from the interaction.</div>
</li>
</ul>
<a name="buildRows-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildRows</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;buildRows(jakarta.resource.cci.Record&nbsp;record,
<a href="../../../../../org/eclipse/persistence/eis/EISAccessor.html" title="class in org.eclipse.persistence.eis">EISAccessor</a>&nbsp;accessor)</pre>
<div class="block">Build a collection of database rows from the Record returned from the interaction.
This handles IndexedRecords used as sets of result records,
and a single MappedRecord with a list of result records.</div>
</li>
</ul>
<a name="getFunctionName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionName</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;getFunctionName()</pre>
<div class="block">PUBLIC:
Return the function name of the interaction.
A function name is a common properties for a CCI InteractionSpec.
This cannot be generically set on the spec as it is not in the interface
however the EIS platform may make use of this in build the interaction spec.</div>
</li>
</ul>
<a name="setFunctionName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFunctionName</h4>
<pre>public&nbsp;void&nbsp;setFunctionName(<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;functionName)</pre>
<div class="block">PUBLIC:
Set the function name of the interaction.
A function name is a common properties for a CCI InteractionSpec.
This cannot be generically set on the spec as it is not in the interface
however the EIS platform may make use of this in build the interaction spec.</div>
</li>
</ul>
<a name="getInputRecordName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputRecordName</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;getInputRecordName()</pre>
<div class="block">PUBLIC:
Return the input record name.
This is used as the name passed to the adapter when creating the input record.</div>
</li>
</ul>
<a name="setInputRecordName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputRecordName</h4>
<pre>public&nbsp;void&nbsp;setInputRecordName(<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;recordName)</pre>
<div class="block">PUBLIC:
Set the input record name.
This is used as the name passed to the adapter when creating the input record.</div>
</li>
</ul>
<a name="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>public&nbsp;<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>&nbsp;getProperties()</pre>
<div class="block">Returns the adapter specific properties.</div>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public&nbsp;<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>&nbsp;getProperty(<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;name)</pre>
<div class="block">PUBLIC:
Returns the adapter property associated the given name.
If the interaction is associated with a query that has a descriptor,
The descriptor's properties are automatically inherited.</div>
</li>
</ul>
<a name="setProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>public&nbsp;void&nbsp;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>&nbsp;properties)</pre>
<div class="block">Set the adapter specific properties.</div>
</li>
</ul>
<a name="setProperty-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public&nbsp;void&nbsp;setProperty(<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;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">PUBLIC:
Set the adapter specific property.</div>
</li>
</ul>
<a name="getInputRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputRow</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;getInputRow()</pre>
<div class="block">INTERNAL:
Return the input database row.</div>
</li>
</ul>
<a name="setInputRow-org.eclipse.persistence.internal.sessions.AbstractRecord-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputRow</h4>
<pre>public&nbsp;void&nbsp;setInputRow(org.eclipse.persistence.internal.sessions.AbstractRecord&nbsp;inputRow)</pre>
<div class="block">PUBLIC:
Set the input database row.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</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;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>&nbsp;in class&nbsp;<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>
</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/eis/interactions/EISInteraction.html" target="_top">Frames</a></li>
<li><a href="EISInteraction.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>