blob: 9c2ff0c8e882029bc8a031f9a1d2dc18f4f7f8e5 [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>
<title>TxBeanManaged</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="TxBeanManaged";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/TxMandatory.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/TxBeanManaged.html" target="_top">Frames</a></li>
<li><a href="TxBeanManaged.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.apache.openejb.core.transaction.JtaTransactionPolicy">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.apache.openejb.core.transaction</div>
<h2 title="Class TxBeanManaged" class="title">Class TxBeanManaged</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">org.apache.openejb.core.transaction.JtaTransactionPolicy</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openejb.core.transaction.TxBeanManaged</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a>, <a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TxBeanManaged</span>
extends <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a>
implements <a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></pre>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.openejb.core.transaction.BeanTransactionPolicy">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a></code></li>
</ul>
<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&nbsp;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>
<!-- =========== 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.apache.openejb.core.transaction.JtaTransactionPolicy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#logger">logger</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionManager">transactionManager</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#transactionType">transactionType</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#txLogger">txLogger</a></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/apache/openejb/core/transaction/TxBeanManaged.html#TxBeanManaged-TransactionManager-">TxBeanManaged</a></span>(TransactionManager&nbsp;transactionManager)</code>&nbsp;</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/apache/openejb/core/transaction/TxBeanManaged.html#commit--">commit</a></span>()</code>
<div class="block">Commits or rolls back this TransactionPolicy.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>Transaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html#getCurrentTransaction--">getCurrentTransaction</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>UserTransaction</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html#getUserTransaction--">getUserTransaction</a></span>()</code>
<div class="block">Gets the UserTransaction the bean uses to manage the transaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html#isClientTransaction--">isClientTransaction</a></span>()</code>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html#isNewTransaction--">isNewTransaction</a></span>()</code>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.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>&nbsp;suspendedTransaction)</code>
<div class="block">Resumes the transaction contained in the suspended transaction token.</div>
</td>
</tr>
<tr id="i6" 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/TxBeanManaged.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.JtaTransactionPolicy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openejb.core.transaction.<a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></h3>
<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#beginTransaction--">beginTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#completeTransaction-Transaction-">completeTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#fireNonTransactionalCompletion--">fireNonTransactionalCompletion</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getResource-java.lang.Object-">getResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransaction--">getTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getTransactionType--">getTransactionType</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#isTransactionActive--">isTransactionActive</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#resumeTransaction-Transaction-">resumeTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#rollbackTransaction-Transaction-">rollbackTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#setRollbackOnly-Transaction-java.lang.Throwable-">setRollbackOnly</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#suspendTransaction--">suspendTransaction</a>, <a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#toString--">toString</a></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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openejb.core.transaction.TransactionPolicy">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#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#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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TxBeanManaged-TransactionManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TxBeanManaged</h4>
<pre>public&nbsp;TxBeanManaged(TransactionManager&nbsp;transactionManager)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<dl>
<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></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isNewTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewTransaction</h4>
<pre>public&nbsp;boolean&nbsp;isNewTransaction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">TransactionPolicy</a></code></span></div>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">isNewTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this not an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="isClientTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClientTransaction</h4>
<pre>public&nbsp;boolean&nbsp;isClientTransaction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">TransactionPolicy</a></code></span></div>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will
return false.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">isClientTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this is an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="getCurrentTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentTransaction</h4>
<pre>public&nbsp;Transaction&nbsp;getCurrentTransaction()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html#getCurrentTransaction--">getCurrentTransaction</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a></code></dd>
</dl>
</li>
</ul>
<a name="getUserTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserTransaction</h4>
<pre>public&nbsp;UserTransaction&nbsp;getUserTransaction()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#getUserTransaction--">BeanTransactionPolicy</a></code></span></div>
<div class="block">Gets the UserTransaction the bean uses to manage the transaction.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#getUserTransaction--">getUserTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></code></dd>
<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>public&nbsp;<a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a>&nbsp;suspendUserTransaction()
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#suspendUserTransaction--">BeanTransactionPolicy</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#suspendUserTransaction--">suspendUserTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>resumeUserTransaction</h4>
<pre>public&nbsp;void&nbsp;resumeUserTransaction(<a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.SuspendedTransaction.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy.SuspendedTransaction</a>&nbsp;suspendedTransaction)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#resumeUserTransaction-org.apache.openejb.core.transaction.BeanTransactionPolicy.SuspendedTransaction-">BeanTransactionPolicy</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html#resumeUserTransaction-org.apache.openejb.core.transaction.BeanTransactionPolicy.SuspendedTransaction-">resumeUserTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></code></dd>
<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>
<a name="commit--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>commit</h4>
<pre>public&nbsp;void&nbsp;commit()
throws <a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a>,
<a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#commit--">TransactionPolicy</a></code></span></div>
<div class="block">Commits or rolls back this TransactionPolicy. If there the actual
transaction is completed or there is no actual transaction, the
registered TransactionSynchronization are called. Otherwise, the
registered TransactionSynchronization are called when the actual
transaction is completed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#commit--">commit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a></code> - if recoverable exception is encountered</dd>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if an unrecoverable exception is encountered</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="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/TxMandatory.html" title="class in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/TxBeanManaged.html" target="_top">Frames</a></li>
<li><a href="TxBeanManaged.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.apache.openejb.core.transaction.JtaTransactionPolicy">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 ======= -->
</body>
</html>