[cvs] expresso commit by lhamel: javadoc

[JCorporate Ltd]

Log Message:
-----------
javadoc

Modified Files:
--------------
    expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/job:
        Job.java

Revision Data
-------------
Index: Job.java
===================================================================
RCS file: /home/javacorp/.cvs/expresso/expresso/expresso-web/WEB-INF/src/com/jcorporate/expresso/core/job/Job.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/job/Job.java -Lexpresso-web/WEB-INF/src/com/jcorporate/expresso/core/job/Job.java -u -r1.31 -r1.32
--- expresso-web/WEB-INF/src/com/jcorporate/expresso/core/job/Job.java
+++ expresso-web/WEB-INF/src/com/jcorporate/expresso/core/job/Job.java
@@ -96,6 +96,11 @@
  * the user initiating the job.  Jobs themselves are executed by JobHandler, and
  * are also capable of getting queued in such a way as to repeatedly execute.
  *
+ * Important: from Expresso 5.6, threadlocal datamembers are expected to hold User ID and
+ * data context.  Therefore, any subclass of Job should set this information
+ * at the beginning of run() by calling, in the subclass, super.run(); as the first line
+ * of the subclass run() method.
+ *
  * @author Michael Nash
  * @see com.jcorporate.expresso.core.utility.JobHandler
  * @since Expresso 1.0