From d30a7dcd49e76434ad5f0365d6e936f59662ddef Mon Sep 17 00:00:00 2001
From: ymlam <ymlam>
Date: Fri, 4 Jul 2014 21:15:33 +0000
Subject: [PATCH] Pruned out unused JobStatus, and comment on use of each
 JobStatus.

---
 src/altk/comm/engine/Job.java | 42 ++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 20 deletions(-)

diff --git a/src/altk/comm/engine/Job.java b/src/altk/comm/engine/Job.java
index b70f88b..84e0d84 100644
--- a/src/altk/comm/engine/Job.java
+++ b/src/altk/comm/engine/Job.java
@@ -8,31 +8,33 @@ package altk.comm.engine;
 public class Job
 {
     /**
-     * 
+     * Because enum has no inheritance, JobStatus is the union of
+     * all possible job status from all backend engines built on CommEngine.
      */
     static public enum JobStatus
     {
+        // TODO: Some of them, like CANCELED and EXPIRED, should not be used, and should be cleaned out.
         READY(false), 
-        TRYING(false),
-        GO_NEXT_PHONE(false),
-        TRUNK_ERROR(false),
-        LONG_DURATION(true),
+        TRYING(false),        // VoiceEngine
+        GO_NEXT_PHONE(false), // VoiceEngine
+        //TRUNK_ERROR(false),
+        LONG_DURATION(true),  // VoiceEngine
         SUCCESS(true),
-        NO_MORE_RETRY(true),
-        ADDRESS_ERROR(true),
-        SERVICE_PROVIDER_PROTOCOL_ERROR(true),
-        SERVICE_PROVIDER_GENERATED_ERROR(true),
-        SERVICE_PROVIDER_HTTP_ERROR(true),
-        SERVICE_PROVIDER_CONNECT_ERROR(true),
-        SERVICE_PROVIDER_OTHER_ERROR(true),
-        CANCELED(true),
-        EXPIRED(true),
-        MESSAGE_ERROR(true),
-        SERVICE_ACCESS_BLOCKED(true),
-        PLATFORM_ERROR(true),
-        FAILED(true), // for
-        UNKNOWN_ERROR(true),
-        ABORT(true);
+        NO_MORE_RETRY(true),  // VoiceEngine
+        ADDRESS_ERROR(true),  // All
+        SERVICE_PROVIDER_PROTOCOL_ERROR(true),  // SMS
+        SERVICE_PROVIDER_GENERATED_ERROR(true), // SMS
+        SERVICE_PROVIDER_HTTP_ERROR(true),      // SMS
+        SERVICE_PROVIDER_CONNECT_ERROR(true),   // SMS
+        SERVICE_PROVIDER_OTHER_ERROR(true),     // Email
+        CANCELED(true),       // Voice - is it really?
+        EXPIRED(true),        // Voice - is it really?
+        MESSAGE_ERROR(true),  // Email, SMS
+        SERVICE_ACCESS_BLOCKED(true),  // SMS
+        PLATFORM_ERROR(true),          // SMS
+        FAILED(true),                  // SMS
+        UNKNOWN_ERROR(true),           // SMS
+        ABORT(true);          // Voice
         
         private boolean isTerminal;