20-12-2022

ECM.JobRunner.Common/Models/Jobs/StatusItem.vb

@@ -9,35 +9,66 @@ Public Class StatusItem
     Public Const STEP_WARNING = "WARNING"
     Public Const STEP_ERROR = "ERROR"
 
-    ' Unique Job Run Id, GUID
+    ''' <summary>
+    ''' Is the job currently executing
+    ''' </summary>
+    Public Executing As Boolean = False
+    ''' <summary>
+    ''' Did the job complete without an error
+    ''' </summary>
+    Public Successful As Boolean = False
+    ''' <summary>
+    ''' Did the job do some work or is/was just waiting for some input
+    ''' </summary>
+    Public Waiting As Boolean = False
+
+    ''' <summary>
+    ''' Unique Job Run Id, GUID
+    ''' </summary>
     Public Id As String
-    ' Job Id, corresponds to Job Schedule in DB
+    ''' <summary>
+    ''' Job Id, corresponds to Job Schedule in DB
+    ''' </summary>
     Public JobId As String
-    ' Job Name, corresponds to Job Schedule Key from Quartz
+    ''' <summary>
+    ''' Job Name, corresponds to Job Schedule Key from Quartz
+    ''' </summary>
     Public Name As String = "Unnamed"
 
     Public Steps As List(Of HistoryStep)
 
     ' Runtime Variables
-    ' Progress Counter
+    ''' <summary>
+    ''' Progress Counter
+    ''' </summary>
     Public ProgressCurrent As Integer = 0
-    ' Total Progress
+    ''' <summary>
+    ''' Total Progress
+    ''' </summary>
     Public ProgressTotal As Integer = 0
-    ' Flag to determin if the job is currently executing/working
-    Public Executing As Boolean = False
-    ' Creation time of job, set by Constructor
+
+    ''' <summary>
+    ''' Creation time of job, set by Constructor
+    ''' </summary>
     Public CreationTime As Date = Date.Now
-    ' Start time of execution, set by JobStatus.Start
+    ''' <summary>
+    ''' Start time of execution, set by JobStatus.Start
+    ''' </summary>
     Public StartTime As Date
-    ' End time of execution, set by JobStatus.Complete
+    ''' <summary>
+    ''' End time of execution, set by JobStatus.Complete
+    ''' </summary>
     Public CompleteTime As Date
-    ' Time of last Progress Update
+    ''' <summary>
+    ''' Time of last Progress Update
+    ''' </summary>
     Public UpdateTime As Date
-    ' Total execution time, calculated by JobStatus.Complete
+    ''' <summary>
+    ''' Total execution time, calculated by JobStatus.Complete
+    ''' </summary>
     Public ExecutionTime As TimeSpan
 
     ' Completion/Failure Messages
-    Public Successful As Boolean = False
     Public SuccessMessage As String = ""
     Public FailureMessage As String = ""