[jboss-svn-commits] JBL Code SVN: r24873 - labs/jbosstm/trunk/ArjunaJTS/jts/classes/com/arjuna/ats/internal/jts/orbspecific.

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

Author: mark.little at jboss.com
Date: 2009-01-22 08:38:04 -0500 (Thu, 22 Jan 2009)
New Revision: 24873

Modified:
   labs/jbosstm/trunk/ArjunaJTS/jts/classes/com/arjuna/ats/internal/jts/orbspecific/ControlImple.java
Log:
added javadoc for getFinalStatus

Modified: labs/jbosstm/trunk/ArjunaJTS/jts/classes/com/arjuna/ats/internal/jts/orbspecific/ControlImple.java
===================================================================
--- labs/jbosstm/trunk/ArjunaJTS/jts/classes/com/arjuna/ats/internal/jts/orbspecific/ControlImple.java	2009-01-22 13:34:56 UTC (rev 24872)
+++ labs/jbosstm/trunk/ArjunaJTS/jts/classes/com/arjuna/ats/internal/jts/orbspecific/ControlImple.java	2009-01-22 13:38:04 UTC (rev 24873)
@@ -338,6 +338,16 @@
 		return false;
 	}
 	
+	/**
+	 * In the case that the transaction is terminated by the reaper then it will
+	 * also be tidied up. This means that the internal handle to the real transaction
+	 * instance will be nulled out. In that case we cache the status just before removing
+	 * the handle and this method can be used to obtain it.
+	 * 
+	 * @return the final termination status of the transaction.
+	 * @throws IllegalStateException thrown if the transaction is still available.
+	 */
+	
 	public org.omg.CosTransactions.Status getFinalStatus () throws IllegalStateException
 	{
 	    if (getImplHandle() != null)