[jboss-svn-commits] JBL Code SVN: r20287 - labs/jbosstm/trunk/XTS/WS-T/dev/src/com/arjuna/wst.

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

Author: adinn
Date: 2008-06-04 06:07:19 -0400 (Wed, 04 Jun 2008)
New Revision: 20287

Modified:
   labs/jbosstm/trunk/XTS/WS-T/dev/src/com/arjuna/wst/BusinessAgreementWithParticipantCompletionParticipant.java
Log:
fix for JBTM-370

Modified: labs/jbosstm/trunk/XTS/WS-T/dev/src/com/arjuna/wst/BusinessAgreementWithParticipantCompletionParticipant.java
===================================================================
--- labs/jbosstm/trunk/XTS/WS-T/dev/src/com/arjuna/wst/BusinessAgreementWithParticipantCompletionParticipant.java	2008-06-04 09:09:57 UTC (rev 20286)
+++ labs/jbosstm/trunk/XTS/WS-T/dev/src/com/arjuna/wst/BusinessAgreementWithParticipantCompletionParticipant.java	2008-06-04 10:07:19 UTC (rev 20287)
@@ -53,6 +53,14 @@
      * The transaction has cancelled. The participant previously
      * informed the coordinator that it had finished work but could compensate
      * later if required, so it is now requested to do so.
+     * @throws FaultedException if the participant was unable to
+     * perform the required compensation action because of an
+     * unrecoverable error. The coordinator is notified of this fault
+     * and as a result will stop resending compensation requests.
+     * @throws SystemException if the participant was unable to
+     * perform the required compensation action because of a transient
+     * fault. The coordinator is not notified of this fault so it
+     * will retry the compensate request after a suitable timeout.
      */
 
     public void compensate () throws FaultedException, WrongStateException, SystemException;