blob: d535168c00e32c035f4722713a7accf3cdfca601 [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>IndexedInteraction (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="IndexedInteraction (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};
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/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.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/IndexedInteraction.html" target="_top">Frames</a></li>
<li><a href="IndexedInteraction.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="#fields.inherited.from.class.org.eclipse.persistence.eis.interactions.EISInteraction">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>Field&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 IndexedInteraction" class="title">Class IndexedInteraction</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>org.eclipse.persistence.eis.interactions.IndexedInteraction</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>, <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">IndexedInteraction</span>
extends <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions">EISInteraction</a></pre>
<div class="block">Defines the specification for a call to a JCA interaction that uses indexed records.
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.IndexedInteraction">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>
<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/IndexedInteraction.html#IndexedInteraction--">IndexedInteraction</a></span>()</code>
<div class="block">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="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/IndexedInteraction.html#addArgument-java.lang.String-">addArgument</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;argumentFieldName)</code>
<div class="block">PUBLIC:
Define the argument to the interaction for the index argument.</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/IndexedInteraction.html#addArgumentValue-java.lang.Object-">addArgumentValue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;argumentValue)</code>
<div class="block">PUBLIC:
Define the argument to the interaction for the index argument.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.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;argumentFieldName)</code>
<div class="block">PUBLIC:
Define the field/argument name to be substitute for the index output argument.</div>
</td>
</tr>
<tr id="i3" 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/IndexedInteraction.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">Build a database row from the record returned from the interaction.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>jakarta.resource.cci.Record</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/eis/interactions/IndexedInteraction.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 an indexed 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/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/IndexedInteraction.html#getArguments--">getArguments</a></span>()</code>
<div class="block">The arguments are the values in order of occurance in the record.</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/IndexedInteraction.html#getOutputArguments--">getOutputArguments</a></span>()</code>
<div class="block">The output arguments in order of occurance in the record.</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/IndexedInteraction.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">The arguments are the values in order of occurance in the record.</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/IndexedInteraction.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 in order of occurance in the record.</div>
</td>
</tr>
</table>
<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-java.lang.String-">addOutputArgument</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#buildRows-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRows</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#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#getLogString-org.eclipse.persistence.internal.databaseaccess.Accessor-">getLogString</a>, <a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArgumentNames--">getOutputArgumentNames</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#prepare-org.eclipse.persistence.internal.sessions.AbstractSession-">prepare</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#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>, <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></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, 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IndexedInteraction--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IndexedInteraction</h4>
<pre>public&nbsp;IndexedInteraction()</pre>
<div class="block">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="addArgument-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addArgument</h4>
<pre>public&nbsp;void&nbsp;addArgument(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;argumentFieldName)</pre>
<div class="block">PUBLIC:
Define the argument to the interaction for the index argument.
This must be called in the order of the arguments in the input indexed record.
The argumentFieldName is the field or argument name in the descriptor that maps to the indexed value.</div>
</li>
</ul>
<a name="addArgumentValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addArgumentValue</h4>
<pre>public&nbsp;void&nbsp;addArgumentValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;argumentValue)</pre>
<div class="block">PUBLIC:
Define the argument to the interaction for the index argument.
This must be called in the order of the arguments in the input indexed record.
The argumentValue is the value of the argument to be used to pass to the interaction.</div>
</li>
</ul>
<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;argumentFieldName)</pre>
<div class="block">PUBLIC:
Define the field/argument name to be substitute for the index output argument.
This must be called in the order of the output arguments in the result indexed record.
The argumentFieldName is the field or argument name in the descriptor that maps to the indexed value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#addOutputArgument-java.lang.String-">addOutputArgument</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="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 arguments are the values in order of occurance in the record.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getArguments--">getArguments</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="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 output arguments in order of occurance in the record.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#getOutputArguments--">getOutputArguments</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="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">The arguments are the values in order of occurance in the record.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setArguments-java.util.Vector-">setArguments</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="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 in order of occurance in the record.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#setOutputArguments-java.util.Vector-">setOutputArguments</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="createInputRecord-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInputRecord</h4>
<pre>public&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 an indexed input record for this interaction.
Populate the data into the record from this interaction's arguments.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#createInputRecord-org.eclipse.persistence.eis.EISAccessor-">createInputRecord</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="buildRow-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildRow</h4>
<pre>public&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">Build a database row from the record returned from the interaction.
Also handles MappedRecords for case of input being indexed but mapped ouput.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/eis/interactions/EISInteraction.html#buildRow-jakarta.resource.cci.Record-org.eclipse.persistence.eis.EISAccessor-">buildRow</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>
</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/EISInteraction.html" title="class in org.eclipse.persistence.eis.interactions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/eis/interactions/MappedInteraction.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/IndexedInteraction.html" target="_top">Frames</a></li>
<li><a href="IndexedInteraction.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="#fields.inherited.from.class.org.eclipse.persistence.eis.interactions.EISInteraction">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>Field&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>