[Mulgara-svn] r1059 - branches/mgr-121-lockrecovery/src/jar/resolver/java/org/mulgara/resolver

[ronald at mulgara.org]

Author: ronald
Date: 2008-07-07 05:54:12 -0700 (Mon, 07 Jul 2008)
New Revision: 1059

Modified:
   branches/mgr-121-lockrecovery/src/jar/resolver/java/org/mulgara/resolver/MulgaraTransaction.java
Log:
Added javadocs for heuristicRollback.


Modified: branches/mgr-121-lockrecovery/src/jar/resolver/java/org/mulgara/resolver/MulgaraTransaction.java
===================================================================
--- branches/mgr-121-lockrecovery/src/jar/resolver/java/org/mulgara/resolver/MulgaraTransaction.java	2008-07-07 12:54:07 UTC (rev 1058)
+++ branches/mgr-121-lockrecovery/src/jar/resolver/java/org/mulgara/resolver/MulgaraTransaction.java	2008-07-07 12:54:12 UTC (rev 1059)
@@ -63,6 +63,13 @@
    */
   MulgaraTransactionException abortTransaction(String errorMessage, Throwable cause) throws MulgaraTransactionException;
 
+  /**
+   * Perform a heuristic rollback on the transaction.
+   *
+   * @param cause the reason for the rollback
+   * @throws MulgaraTransactionException if an error is encounted while attempting to roll back;
+   *                                     the transaction will still have been terminated, though.
+   */
   void heuristicRollback(String cause) throws MulgaraTransactionException;
 
   /**