svn commit: r1369491 - in /ofbiz/trunk/framework/service/src/org/ofbiz/service/job: GenericServiceJob.java Job.java

[adrianc]

Author: adrianc
Date: Sat Aug  4 22:17:02 2012
New Revision: 1369491

URL: http://svn.apache.org/viewvc?rev=1369491&view=rev
Log:
Some JavaDocs to help explain the Job behavior.

Modified:
    ofbiz/trunk/framework/service/src/org/ofbiz/service/job/GenericServiceJob.java
    ofbiz/trunk/framework/service/src/org/ofbiz/service/job/Job.java

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/job/GenericServiceJob.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/job/GenericServiceJob.java?rev=1369491&r1=1369490&r2=1369491&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/job/GenericServiceJob.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/job/GenericServiceJob.java Sat Aug  4 22:17:02 2012
@@ -97,7 +97,7 @@ public class GenericServiceJob extends A
     }
 
     /**
-     * Method is called after the service has finished.
+     * Method is called after the service has finished successfully.
      */
     protected void finish(Map<String, Object> result) throws InvalidJobException {
         if (currentState != State.RUNNING) {

Modified: ofbiz/trunk/framework/service/src/org/ofbiz/service/job/Job.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/src/org/ofbiz/service/job/Job.java?rev=1369491&r1=1369490&r2=1369491&view=diff
==============================================================================
--- ofbiz/trunk/framework/service/src/org/ofbiz/service/job/Job.java (original)
+++ ofbiz/trunk/framework/service/src/org/ofbiz/service/job/Job.java Sat Aug  4 22:17:02 2012
@@ -20,6 +20,10 @@ package org.ofbiz.service.job;
 
 /**
  * A scheduled job.
+ * <p>A job starts out in the created state. When the job is queued for execution, it
+ * transitions to the queued state. While the job is executing it is in the running state.
+ * When the job execution ends, it transitions to the finished or failed state - depending
+ * on the outcome of the task that was performed.</p>
  */
 public interface Job {