| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>BeanTransactionPolicy</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="BeanTransactionPolicy"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":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>Prev Class</li> |
| <li><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/transaction/BeanTransactionPolicy.html" target="_top">Frames</a></li> |
| <li><a href="BeanTransactionPolicy.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><a href="#nested.class.summary">Nested</a> | </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">org.apache.openejb.core.transaction</div> |
| <h2 title="Interface BeanTransactionPolicy" class="title">Interface BeanTransactionPolicy</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html" title="class in org.apache.openejb.core.transaction">TxBeanManaged</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">BeanTransactionPolicy</span> |
| extends <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></pre> |
| <div class="block">BeanTransactionPolicy is an extension to the TransactionPolicy which provides |
| operations for controlling a JEE bean managed transaction.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a></span></code> |
| <div class="block">Represents a suspended transaction.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.openejb.core.transaction.TransactionPolicy"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></h3> |
| <code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a></code></li> |
| </ul> |
| </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"> </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>UserTransaction</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#getUserTransaction--">getUserTransaction</a></span>()</code> |
| <div class="block">Gets the UserTransaction the bean uses to manage the transaction.</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/apache/openejb/core/transaction/BeanTransactionPolicy.html#resumeUserTransaction-org.apache.openejb.core.transaction.BeanTransactionPolicy.SuspendedTransaction-">resumeUserTransaction</a></span>(<a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a> suspendedTransaction)</code> |
| <div class="block">Resumes the transaction contained in the suspended transaction token.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#suspendUserTransaction--">suspendUserTransaction</a></span>()</code> |
| <div class="block">Syspends the bean managed transaction.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.core.transaction.TransactionPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></h3> |
| <code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#commit--">commit</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getResource-java.lang.Object-">getResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getTransactionType--">getTransactionType</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">isClientTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">isNewTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isTransactionActive--">isTransactionActive</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a></code></li> |
| </ul> |
| </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="getUserTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserTransaction</h4> |
| <pre>UserTransaction getUserTransaction()</pre> |
| <div class="block">Gets the UserTransaction the bean uses to manage the transaction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UserTransaction the bean uses to manage the transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="suspendUserTransaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>suspendUserTransaction</h4> |
| <pre><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a> suspendUserTransaction() |
| throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre> |
| <div class="block">Syspends the bean managed transaction. This is mainly used by stateful |
| session beans which are required to maintain the bean managed transaction |
| between calls. After this method completes the transaction will be |
| suspended or if there is a problem it will be rolled back.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the syspended transaction token or null if no transaction was |
| active</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if there was a problem suspending the |
| transaction</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resumeUserTransaction-org.apache.openejb.core.transaction.BeanTransactionPolicy.SuspendedTransaction-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resumeUserTransaction</h4> |
| <pre>void resumeUserTransaction(<a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a> suspendedTransaction) |
| throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre> |
| <div class="block">Resumes the transaction contained in the suspended transaction token. |
| After this method completes the transaction will be resumes or if there |
| is a problem it will be rolled back.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>suspendedTransaction</code> - the transaction to resume; not null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if there was a problem resuming the transaction</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>Prev Class</li> |
| <li><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openejb/core/transaction/BeanTransactionPolicy.html" target="_top">Frames</a></li> |
| <li><a href="BeanTransactionPolicy.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><a href="#nested.class.summary">Nested</a> | </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> |
