| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Transaction</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="Transaction"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/transaction/Transactional.html" title="annotation in javax.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/transaction/Transaction.html" target="_top">Frames</a></li> |
| <li><a href="Transaction.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">javax.transaction</div> |
| <h2 title="Interface Transaction" class="title">Interface Transaction</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../org/apache/openejb/ri/sp/PseudoTransactionService.MyTransaction.html" title="class in org.apache.openejb.ri.sp">PseudoTransactionService.MyTransaction</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Transaction</span></pre> |
| <div class="block">The Transaction interface allows operations to be performed against |
| the transaction in the target Transaction object. A Transaction |
| object is created corresponding to each global transaction creation. |
| The Transaction object can be used for resource enlistment, |
| synchronization registration, transaction completion, and status |
| query operations.</div> |
| </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="../../javax/transaction/Transaction.html#commit--">commit</a></span>()</code> |
| <div class="block">Complete the transaction represented by this Transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#delistResource-javax.transaction.xa.XAResource-int-">delistResource</a></span>(javax.transaction.xa.XAResource xaRes, |
| int flag)</code> |
| <div class="block">Disassociate the resource specified from the transaction associated |
| with the target Transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a></span>(javax.transaction.xa.XAResource xaRes)</code> |
| <div class="block">Enlist the resource specified with the transaction associated with the |
| target Transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#getStatus--">getStatus</a></span>()</code> |
| <div class="block">Obtain the status of the transaction associated with the target |
| Transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#registerSynchronization-javax.transaction.Synchronization-">registerSynchronization</a></span>(<a href="../../javax/transaction/Synchronization.html" title="interface in javax.transaction">Synchronization</a> sync)</code> |
| <div class="block">Register a synchronization object for the transaction currently |
| associated with the target object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#rollback--">rollback</a></span>()</code> |
| <div class="block">Rollback the transaction represented by this Transaction object.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/transaction/Transaction.html#setRollbackOnly--">setRollbackOnly</a></span>()</code> |
| <div class="block">Modify the transaction associated with the target object such that |
| the only possible outcome of the transaction is to roll back the |
| transaction.</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="commit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>void commit() |
| throws <a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a>, |
| <a href="../../javax/transaction/HeuristicMixedException.html" title="class in javax.transaction">HeuristicMixedException</a>, |
| <a href="../../javax/transaction/HeuristicRollbackException.html" title="class in javax.transaction">HeuristicRollbackException</a>, |
| java.lang.SecurityException, |
| java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Complete the transaction represented by this Transaction object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a></code> - Thrown to indicate that |
| the transaction has been rolled back rather than committed.</dd> |
| <dd><code><a href="../../javax/transaction/HeuristicMixedException.html" title="class in javax.transaction">HeuristicMixedException</a></code> - Thrown to indicate that a heuristic |
| decision was made and that some relevant updates have been committed |
| while others have been rolled back.</dd> |
| <dd><code><a href="../../javax/transaction/HeuristicRollbackException.html" title="class in javax.transaction">HeuristicRollbackException</a></code> - Thrown to indicate that a |
| heuristic decision was made and that all relevant updates have been |
| rolled back.</dd> |
| <dd><code>java.lang.SecurityException</code> - Thrown to indicate that the thread is |
| not allowed to commit the transaction.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the transaction in the |
| target object is inactive.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delistResource-javax.transaction.xa.XAResource-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delistResource</h4> |
| <pre>boolean delistResource(javax.transaction.xa.XAResource xaRes, |
| int flag) |
| throws java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Disassociate the resource specified from the transaction associated |
| with the target Transaction object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xaRes</code> - The XAResource object associated with the resource |
| (connection).</dd> |
| <dd><code>flag</code> - One of the values of TMSUCCESS, TMSUSPEND, or TMFAIL.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><i>true</i> if the resource was delisted successfully; otherwise |
| <i>false</i>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the transaction in the |
| target object is inactive.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enlistResource-javax.transaction.xa.XAResource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enlistResource</h4> |
| <pre>boolean enlistResource(javax.transaction.xa.XAResource xaRes) |
| throws <a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a>, |
| java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Enlist the resource specified with the transaction associated with the |
| target Transaction object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xaRes</code> - The XAResource object associated with the resource |
| (connection).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><i>true</i> if the resource was enlisted successfully; otherwise |
| <i>false</i>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a></code> - Thrown to indicate that |
| the transaction has been marked for rollback only.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the transaction in the |
| target object is in the prepared state or the transaction is |
| inactive.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatus</h4> |
| <pre>int getStatus() |
| throws <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Obtain the status of the transaction associated with the target |
| Transaction object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The transaction status. If no transaction is associated with |
| the target object, this method returns the |
| Status.NoTransaction value.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerSynchronization-javax.transaction.Synchronization-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerSynchronization</h4> |
| <pre>void registerSynchronization(<a href="../../javax/transaction/Synchronization.html" title="interface in javax.transaction">Synchronization</a> sync) |
| throws <a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a>, |
| java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Register a synchronization object for the transaction currently |
| associated with the target object. The transction manager invokes |
| the beforeCompletion method prior to starting the two-phase transaction |
| commit process. After the transaction is completed, the transaction |
| manager invokes the afterCompletion method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sync</code> - The Synchronization object for the transaction associated |
| with the target object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../javax/transaction/RollbackException.html" title="class in javax.transaction">RollbackException</a></code> - Thrown to indicate that |
| the transaction has been marked for rollback only.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the transaction in the |
| target object is in the prepared state or the transaction is |
| inactive.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>void rollback() |
| throws java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Rollback the transaction represented by this Transaction object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the transaction in the |
| target object is in the prepared state or the transaction is |
| inactive.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRollbackOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setRollbackOnly</h4> |
| <pre>void setRollbackOnly() |
| throws java.lang.IllegalStateException, |
| <a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></pre> |
| <div class="block">Modify the transaction associated with the target object such that |
| the only possible outcome of the transaction is to roll back the |
| transaction.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - Thrown if the target object is |
| not associated with any transaction.</dd> |
| <dd><code><a href="../../javax/transaction/SystemException.html" title="class in javax.transaction">SystemException</a></code> - Thrown if the transaction manager |
| encounters an unexpected error condition.</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="../../javax/transaction/SystemException.html" title="class in javax.transaction"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/transaction/Transactional.html" title="annotation in javax.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/transaction/Transaction.html" target="_top">Frames</a></li> |
| <li><a href="Transaction.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> |
