| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Interaction</title> |
| <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="Interaction"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/cci/IndexedRecord.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/cci/Interaction.html" target="_top">Frames</a></li> |
| <li><a href="Interaction.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.resource.cci</div> |
| <h2 title="Interface Interaction" class="title">Interface Interaction</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Interaction</span></pre> |
| <div class="block">The <code>javax.resource.cci.Interaction</code> enables a component to |
| execute EIS functions. An Interaction instance supports the following ways |
| of interacting with an EIS instance: |
| <UL> |
| <LI><code>execute</code> method that takes an input Record, output |
| Record and an InteractionSpec. This method executes the EIS |
| function represented by the InteractionSpec and updates the |
| output Record |
| <LI><code>execute</code> method that takes an input Record and an |
| InteractionSpec. This method implementation executes the EIS |
| function represented by the InteractionSpec and produces the |
| output Record as a return value. |
| </UL> |
| <p>An Interaction instance is created from a Connection and is required |
| to maintain its association with the Connection instance. The close method |
| releases all resources maintained by the resource adapter for the |
| Interaction. The close of an Interaction instance should not close the |
| associated Connection instance.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ResultSet</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#clearWarnings--">clearWarnings</a></span>()</code> |
| <div class="block">Clears all the warning reported by this Interaction instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#close--">close</a></span>()</code> |
| <div class="block">Closes the current Interaction and release all the resources |
| held for this instance by the resource adapter.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#execute-jakarta.resource.cci.InteractionSpec-jakarta.resource.cci.Record-">execute</a></span>(<a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci">InteractionSpec</a> ispec, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> input)</code> |
| <div class="block">Executes an interaction represented by the InteractionSpec.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#execute-jakarta.resource.cci.InteractionSpec-jakarta.resource.cci.Record-jakarta.resource.cci.Record-">execute</a></span>(<a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci">InteractionSpec</a> ispec, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> input, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> output)</code> |
| <div class="block">Executes an interaction represented by the InteractionSpec.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/resource/cci/Connection.html" title="interface in jakarta.resource.cci">Connection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#getConnection--">getConnection</a></span>()</code> |
| <div class="block">Gets the Connection associated with the Interaction.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/resource/cci/ResourceWarning.html" title="class in jakarta.resource.cci">ResourceWarning</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/Interaction.html#getWarnings--">getWarnings</a></span>()</code> |
| <div class="block">Gets the first ResourceWarning from the chain of warnings |
| associated with this Interaction instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close() |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block">Closes the current Interaction and release all the resources |
| held for this instance by the resource adapter. The close of an |
| Interaction instance does not close the associated Connection |
| instance. It is recommended that Interaction instances be |
| closed explicitly to free any held resources.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Failed to close the Interaction |
| instance. Invoking close on an |
| already closed Interaction should |
| also throw this exception.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre><a href="../../../jakarta/resource/cci/Connection.html" title="interface in jakarta.resource.cci">Connection</a> getConnection()</pre> |
| <div class="block">Gets the Connection associated with the Interaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Connection instance associated with the Interaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-jakarta.resource.cci.InteractionSpec-jakarta.resource.cci.Record-jakarta.resource.cci.Record-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>boolean execute(<a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci">InteractionSpec</a> ispec, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> input, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> output) |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block">Executes an interaction represented by the InteractionSpec. |
| This form of invocation takes an input Record and updates |
| the output Record.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ispec</code> - InteractionSpec representing a target EIS |
| data/function module</dd> |
| <dd><code>input</code> - Input Record</dd> |
| <dd><code>output</code> - Output Record</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if execution of the EIS function has been |
| successful and output Record has been updated; false |
| otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Exception if execute operation |
| fails. Examples of error cases |
| are: |
| <UL> |
| <LI> Resource adapter internal, EIS-specific or |
| communication error |
| <LI> Invalid specification of an InteractionSpec, |
| input or output record structure |
| <LI> Errors in use of input or output Record |
| <LI> Invalid connection associated with this |
| Interaction |
| </UL></dd> |
| <dd><code><a href="../../../jakarta/resource/NotSupportedException.html" title="class in jakarta.resource">NotSupportedException</a></code> - Operation not supported</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-jakarta.resource.cci.InteractionSpec-jakarta.resource.cci.Record-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> execute(<a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci">InteractionSpec</a> ispec, |
| <a href="../../../jakarta/resource/cci/Record.html" title="interface in jakarta.resource.cci">Record</a> input) |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block">Executes an interaction represented by the InteractionSpec. |
| This form of invocation takes an input Record and returns an |
| output Record if the execution of the Interaction has been |
| successfull.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ispec</code> - InteractionSpec representing a target EIS |
| data/function module</dd> |
| <dd><code>input</code> - Input Record</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>output Record if execution of the EIS function has been |
| successful; null otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Exception if execute operation |
| fails. Examples of error cases |
| are: |
| <UL> |
| <LI> Resource adapter internal, EIS-specific or |
| communication error |
| <LI> Invalid specification of an InteractionSpec |
| or input record structure |
| <LI> Errors in use of input Record or creation |
| of an output Record |
| <LI> Invalid connection associated with this |
| Interaction |
| </UL></dd> |
| <dd><code><a href="../../../jakarta/resource/NotSupportedException.html" title="class in jakarta.resource">NotSupportedException</a></code> - Operation not supported</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWarnings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWarnings</h4> |
| <pre><a href="../../../jakarta/resource/cci/ResourceWarning.html" title="class in jakarta.resource.cci">ResourceWarning</a> getWarnings() |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block">Gets the first ResourceWarning from the chain of warnings |
| associated with this Interaction instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ResourceWarning at top of the warning chain</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Failed to get ResourceWarnings |
| associated with Interaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearWarnings--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clearWarnings</h4> |
| <pre>void clearWarnings() |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block">Clears all the warning reported by this Interaction instance. After |
| a call to this method, the method getWarnings will return null |
| until a new warning is reported for this Interaction.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Failed to clear ResourceWarnings |
| associated with Interaction</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/cci/IndexedRecord.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/cci/Interaction.html" target="_top">Frames</a></li> |
| <li><a href="Interaction.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
