[jboss-svn-commits] JBL Code SVN: r17556 - labs/jbossesb/branches/JBESB_4_2_1_GA_CP/product/rosetta/src/org/jboss/soa/esb/listeners/gateway.

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

Author: tcunning
Date: 2008-01-04 11:55:03 -0500 (Fri, 04 Jan 2008)
New Revision: 17556

Modified:
   labs/jbossesb/branches/JBESB_4_2_1_GA_CP/product/rosetta/src/org/jboss/soa/esb/listeners/gateway/SqlTableGatewayListener.java
Log:
bug:JBESB-1419
Add documentation about the upper cased convention used in STATUS_COL.


Modified: labs/jbossesb/branches/JBESB_4_2_1_GA_CP/product/rosetta/src/org/jboss/soa/esb/listeners/gateway/SqlTableGatewayListener.java
===================================================================
--- labs/jbossesb/branches/JBESB_4_2_1_GA_CP/product/rosetta/src/org/jboss/soa/esb/listeners/gateway/SqlTableGatewayListener.java	2008-01-04 16:48:03 UTC (rev 17555)
+++ labs/jbossesb/branches/JBESB_4_2_1_GA_CP/product/rosetta/src/org/jboss/soa/esb/listeners/gateway/SqlTableGatewayListener.java	2008-01-04 16:55:03 UTC (rev 17556)
@@ -84,10 +84,13 @@
  * <p/> The following fields are mandatory (see checkMyParms()): <br/> <br/>SQL
  * table name <br/>list of fields to retrieve <br/>list of key fields to use in
  * the update statement <br/>a field that will be used to mark a row as
- * 'pending(p)', 'in process(w)', 'done(d)' or 'in error(e)'
+ * 'P' (pending), 'W' (in process), 'D' (done) or 'E' (error).      When adding
+ * a pending row, make sure that the status_col value if an upper-cased 'P', as 
+ * upper-cased characters are used as a convention.
  *
  * @author <a
  *         href="mailto:schifest at heuristica.com.ar">schifest at heuristica.com.ar</a>
+ * @author <a href="mailto:tcunning at redhat.com">tcunning at redhat.com</a>
  * @since Version 4.0
  */
 public class SqlTableGatewayListener extends AbstractThreadedManagedLifecycle {