jakartaee-9.0/javadoc/jakarta/transaction/TransactionManager.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>TransactionManager</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="TransactionManager";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/transaction/TransactionalException.html" title="class in jakarta.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/transaction/TransactionRequiredException.html" title="class in jakarta.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/transaction/TransactionManager.html" target="_top">Frames</a></li>
 <li><a href="TransactionManager.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>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>Constr&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">jakarta.transaction</div>
 <h2 title="Interface TransactionManager" class="title">Interface TransactionManager</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">TransactionManager</span></pre>
 <div class="block">The TransactionManager interface defines the methods that allow an
  application server to manage transaction boundaries.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../jakarta/transaction/TransactionManager.html#begin--">begin</a></span>()</code>
 <div class="block">Create a new transaction and associate it with the current thread.</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/transaction/TransactionManager.html#commit--">commit</a></span>()</code>
 <div class="block">Complete the transaction associated with the current thread.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#getStatus--">getStatus</a></span>()</code>
 <div class="block">Obtain the status of the transaction associated with the current thread.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#getTransaction--">getTransaction</a></span>()</code>
 <div class="block">Get the transaction object that represents the transaction
  context of the calling thread.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#resume-jakarta.transaction.Transaction-">resume</a></span>(<a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a>&nbsp;tobj)</code>
 <div class="block">Resume the transaction context association of the calling thread
  with the transaction represented by the supplied Transaction 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="../../jakarta/transaction/TransactionManager.html#rollback--">rollback</a></span>()</code>
 <div class="block">Roll back the transaction associated with the current thread.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#setRollbackOnly--">setRollbackOnly</a></span>()</code>
 <div class="block">Modify the transaction associated with the current thread such that
  the only possible outcome of the transaction is to roll back the
  transaction.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#setTransactionTimeout-int-">setTransactionTimeout</a></span>(int&nbsp;seconds)</code>
 <div class="block">Modify the timeout value that is associated with transactions started
  by the current thread with the begin method.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code><a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/transaction/TransactionManager.html#suspend--">suspend</a></span>()</code>
 <div class="block">Suspend the transaction currently associated with the calling
  thread and return a Transaction object that represents the
  transaction context being suspended.</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="begin--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>begin</h4>
 <pre>void&nbsp;begin()
     throws <a href="../../jakarta/transaction/NotSupportedException.html" title="class in jakarta.transaction">NotSupportedException</a>,
            <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Create a new transaction and associate it with the current thread.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/NotSupportedException.html" title="class in jakarta.transaction">NotSupportedException</a></code> - Thrown if the thread is already
     associated with a transaction and the Transaction Manager
     implementation does not support nested transactions.</dd>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="commit--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>commit</h4>
 <pre>void&nbsp;commit()
      throws <a href="../../jakarta/transaction/RollbackException.html" title="class in jakarta.transaction">RollbackException</a>,
             <a href="../../jakarta/transaction/HeuristicMixedException.html" title="class in jakarta.transaction">HeuristicMixedException</a>,
             <a href="../../jakarta/transaction/HeuristicRollbackException.html" title="class in jakarta.transaction">HeuristicRollbackException</a>,
             java.lang.SecurityException,
             java.lang.IllegalStateException,
             <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Complete the transaction associated with the current thread. When this
  method completes, the thread is no longer associated with a transaction.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/RollbackException.html" title="class in jakarta.transaction">RollbackException</a></code> - Thrown to indicate that
     the transaction has been rolled back rather than committed.</dd>
 <dd><code><a href="../../jakarta/transaction/HeuristicMixedException.html" title="class in jakarta.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="../../jakarta/transaction/HeuristicRollbackException.html" title="class in jakarta.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 current thread is
     not associated with a transaction.</dd>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.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&nbsp;getStatus()
        throws <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Obtain the status of the transaction associated with the current thread.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The transaction status. If no transaction is associated with
     the current thread, this method returns the Status.NoTransaction
     value.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="getTransaction--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTransaction</h4>
 <pre><a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a>&nbsp;getTransaction()
                     throws <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Get the transaction object that represents the transaction
  context of the calling thread.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <code>Transaction</code> object representing the
           transaction associated with the calling thread.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="resume-jakarta.transaction.Transaction-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>resume</h4>
 <pre>void&nbsp;resume(<a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a>&nbsp;tobj)
      throws <a href="../../jakarta/transaction/InvalidTransactionException.html" title="class in jakarta.transaction">InvalidTransactionException</a>,
             java.lang.IllegalStateException,
             <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Resume the transaction context association of the calling thread
  with the transaction represented by the supplied Transaction object.
  When this method returns, the calling thread is associated with the
  transaction context specified.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>tobj</code> - The <code>Transaction</code> object that represents the
     transaction to be resumed.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/InvalidTransactionException.html" title="class in jakarta.transaction">InvalidTransactionException</a></code> - Thrown if the parameter
     transaction object contains an invalid transaction.</dd>
 <dd><code>java.lang.IllegalStateException</code> - Thrown if the thread is already
     associated with another transaction.</dd>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.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&nbsp;rollback()
        throws java.lang.IllegalStateException,
               java.lang.SecurityException,
               <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Roll back the transaction associated with the current thread. When this
  method completes, the thread is no longer associated with a
  transaction.</div>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code>java.lang.SecurityException</code> - Thrown to indicate that the thread is
     not allowed to roll back the transaction.</dd>
 <dd><code>java.lang.IllegalStateException</code> - Thrown if the current thread is
     not associated with a transaction.</dd>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="setRollbackOnly--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setRollbackOnly</h4>
 <pre>void&nbsp;setRollbackOnly()
               throws java.lang.IllegalStateException,
                      <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Modify the transaction associated with the current thread 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 current thread is
     not associated with a transaction.</dd>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="setTransactionTimeout-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setTransactionTimeout</h4>
 <pre>void&nbsp;setTransactionTimeout(int&nbsp;seconds)
                     throws <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Modify the timeout value that is associated with transactions started
  by the current thread with the begin method.

  <p> If an application has not called this method, the transaction
  service uses some default value for the transaction timeout.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>seconds</code> - The value of the timeout in seconds. If the value is zero,
         the transaction service restores the default value. If the value
         is negative a SystemException is thrown.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></code> - Thrown if the transaction manager
     encounters an unexpected error condition.</dd>
 </dl>
 </li>
 </ul>
 <a name="suspend--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>suspend</h4>
 <pre><a href="../../jakarta/transaction/Transaction.html" title="interface in jakarta.transaction">Transaction</a>&nbsp;suspend()
              throws <a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.transaction">SystemException</a></pre>
 <div class="block">Suspend the transaction currently associated with the calling
  thread and return a Transaction object that represents the
  transaction context being suspended. If the calling thread is
  not associated with a transaction, the method returns a null
  object reference. When this method returns, the calling thread
  is not associated with a transaction.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Transaction object representing the suspended transaction.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../jakarta/transaction/SystemException.html" title="class in jakarta.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="../../jakarta/transaction/TransactionalException.html" title="class in jakarta.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/transaction/TransactionRequiredException.html" title="class in jakarta.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/transaction/TransactionManager.html" target="_top">Frames</a></li>
 <li><a href="TransactionManager.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>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>Constr&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>