Package com.broadleafcommerce.scheduledjob.domain

Class ScheduledJobExecutionDetail

java.lang.Object
com.broadleafcommerce.scheduledjob.domain.ScheduledJobExecutionDetail
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class ScheduledJobExecutionDetail extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
Represents a DTO to hold the execution details of a scheduled job. Its instance is created for each scheduled job execution.

It is used for recording the history of past executions of a scheduled job.

Since:
Scheduled Job Service 2.1.4, Release Train 2.1.4, Scheduled Job Service 2.2.0, Release Train 2.2.0
Author:
karanjariwala
See Also:

  • Constructor Details

    • ScheduledJobExecutionDetail

      public ScheduledJobExecutionDetail(String jobId, String executionId, String status, Instant triggerTime, Instant startTime, Instant endTime, Instant lastUpdatedTime, String noteMessage, String errorMessage, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState, Map<String,Object> attributes)

    • ScheduledJobExecutionDetail

      public ScheduledJobExecutionDetail()

  • Method Details

    • getJobId

      public String getJobId()
      The ID of the scheduled job for which this execution detail is created

    • getExecutionId

      public String getExecutionId()
      The context ID of the execution detail

    • getStatus

      public String getStatus()
      The execution status of the scheduled job
      See Also:

    • getTriggerTime

      public Instant getTriggerTime()
      The time at which the scheduled job is triggered

    • getStartTime

      public Instant getStartTime()
      The time at which the scheduled job starts execution

    • getEndTime

      public Instant getEndTime()
      The time at which the scheduled job finishes execution

    • getLastUpdatedTime

      public Instant getLastUpdatedTime()
      The time at which the scheduled job is last updated

    • getNoteMessage

      public String getNoteMessage()
      The execution note/message to be set on the execution detail. In case of a successful execution, it will be set with information about the job execution

    • getErrorMessage

      public String getErrorMessage()
      The error message if any to set on the execution detail. In case of an unsuccessful execution, it will be set with error information about the job execution

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • getAttributes

      public Map<String,Object> getAttributes()
      A map to hold additional information on the execution detail

    • setJobId

      public void setJobId(String jobId)
      The ID of the scheduled job for which this execution detail is created

    • setExecutionId

      public void setExecutionId(String executionId)
      The context ID of the execution detail

    • setStatus

      public void setStatus(String status)
      The execution status of the scheduled job
      See Also:

    • setTriggerTime

      public void setTriggerTime(Instant triggerTime)
      The time at which the scheduled job is triggered

    • setStartTime

      public void setStartTime(Instant startTime)
      The time at which the scheduled job starts execution

    • setEndTime

      public void setEndTime(Instant endTime)
      The time at which the scheduled job finishes execution

    • setLastUpdatedTime

      public void setLastUpdatedTime(Instant lastUpdatedTime)
      The time at which the scheduled job is last updated

    • setNoteMessage

      public void setNoteMessage(String noteMessage)
      The execution note/message to be set on the execution detail. In case of a successful execution, it will be set with information about the job execution

    • setErrorMessage

      public void setErrorMessage(String errorMessage)
      The error message if any to set on the execution detail. In case of an unsuccessful execution, it will be set with error information about the job execution

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      A map to hold additional information on the execution detail

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object