[jboss-svn-commits] JBL Code SVN: r26796 - labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/resources/spi.

[jboss-svn-commits at lists.jboss.org]

Author: mark.little at jboss.com
Date: 2009-06-01 09:35:15 -0400 (Mon, 01 Jun 2009)
New Revision: 26796

Modified:
   labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/resources/spi/XATerminatorExtensions.java
Log:
updated javadocs

Modified: labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/resources/spi/XATerminatorExtensions.java
===================================================================
--- labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/resources/spi/XATerminatorExtensions.java	2009-06-01 12:15:26 UTC (rev 26795)
+++ labs/jbosstm/trunk/ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/resources/spi/XATerminatorExtensions.java	2009-06-01 13:35:15 UTC (rev 26796)
@@ -52,14 +52,23 @@
      * OTS. But it's not a big deal.
      */
     
+    /**
+     * Call beforeCompletion on the registered instance. Exceptions will cause the transaction
+     * to rollback.
+     * 
+     * @param xid the transaction instance.
+     * @return success (or not).
+     */
+    
     public boolean beforeCompletion (Xid xid) throws javax.transaction.SystemException;
     
     /**
-     * Status should be in JTA status values.
+     * Call afterCompletion on the registered instance. Exceptions will be logged but have no
+     * affect on the transaction (which has already completed.)
      * 
-     * @param xid
-     * @param status
-     * @return
+     * @param xid the transaction instance
+     * @param status the transaction status (values from JTA Status).
+     * @return success (or not).
      * @throws javax.transaction.SystemException
      */