Interface HistoricJobLog

  • All Known Implementing Classes:
    HistoricJobLogEventEntity

    public interface HistoricJobLog

    The HistoricJobLog is used to have a log containing information about job execution. The log provides details about the complete lifecycle of a job:

    • job created
    • job execution failed
    • job execution successful
    • job was deleted
    An instance of HistoricJobLog represents a state in the lifecycle of a job.
    Since:
    7.3
    Author:
    Roman Smirnov
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      Returns the id of the activity on which the associated job was created.
      java.lang.String getDeploymentId()
      Returns the specific deployment id on which the associated job was created.
      java.lang.String getExecutionId()
      Returns the specific execution id on which the associated job was created.
      java.lang.String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.
      java.lang.String getHostname()
      Returns the name of the host where the Process Engine that added this job log runs.
      java.lang.String getId()
      Returns the unique identifier for this historic job log.
      java.lang.String getJobDefinitionConfiguration()
      Returns the job definition configuration type of the associated job.
      java.lang.String getJobDefinitionId()
      Returns the id of the job definition on which the associated job was created.
      java.lang.String getJobDefinitionType()
      Returns the job definition type of the associated job.
      java.util.Date getJobDueDate()
      Returns the due date of the associated job when this log occurred.
      java.lang.String getJobExceptionMessage()
      Returns the message of the exception that occurred by executing the associated job.
      java.lang.String getJobId()
      Returns the id of the associated job.
      long getJobPriority()
      Returns the priority of the associated job when this log entry was created.
      int getJobRetries()
      Returns the retries of the associated job before the associated job has been executed and when this log occurred.
      java.lang.String getProcessDefinitionId()
      Returns the specific process definition id on which the associated job was created.
      java.lang.String getProcessDefinitionKey()
      Returns the specific process definition key on which the associated job was created.
      java.lang.String getProcessInstanceId()
      Returns the specific process instance id on which the associated job was created.
      java.util.Date getRemovalTime()
      The time the historic job log will be removed.
      java.lang.String getRootProcessInstanceId()
      Returns the specific root process instance id of the process instance on which the associated job was created.
      java.lang.String getTenantId()
      Returns the id of the tenant this job log entry belongs to.
      java.util.Date getTimestamp()
      Returns the time when this log occurred.
      boolean isCreationLog()
      Returns true when this log represents the creation of the associated job.
      boolean isDeletionLog()
      Returns true when this log represents the deletion of the associated job.
      boolean isFailureLog()
      Returns true when this log represents the failed execution of the associated job.
      boolean isSuccessLog()
      Returns true when this log represents the successful execution of the associated job.
    • Method Detail

      • getId

        java.lang.String getId()
        Returns the unique identifier for this historic job log.
      • getTimestamp

        java.util.Date getTimestamp()
        Returns the time when this log occurred.
      • getJobId

        java.lang.String getJobId()
        Returns the id of the associated job.
      • getJobDueDate

        java.util.Date getJobDueDate()
        Returns the due date of the associated job when this log occurred.
      • getJobRetries

        int getJobRetries()
        Returns the retries of the associated job before the associated job has been executed and when this log occurred.
      • getJobPriority

        long getJobPriority()
        Returns the priority of the associated job when this log entry was created.
        Since:
        7.4
      • getJobDefinitionId

        java.lang.String getJobDefinitionId()
        Returns the id of the job definition on which the associated job was created.
      • getJobDefinitionType

        java.lang.String getJobDefinitionType()
        Returns the job definition type of the associated job.
      • getJobDefinitionConfiguration

        java.lang.String getJobDefinitionConfiguration()
        Returns the job definition configuration type of the associated job.
      • getActivityId

        java.lang.String getActivityId()
        Returns the id of the activity on which the associated job was created.
      • getFailedActivityId

        java.lang.String getFailedActivityId()
        Returns the id of the activity on which the last exception occurred.
      • getExecutionId

        java.lang.String getExecutionId()
        Returns the specific execution id on which the associated job was created.
      • getRootProcessInstanceId

        java.lang.String getRootProcessInstanceId()
        Returns the specific root process instance id of the process instance on which the associated job was created.
      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Returns the specific process instance id on which the associated job was created.
      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Returns the specific process definition id on which the associated job was created.
      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        Returns the specific process definition key on which the associated job was created.
      • getDeploymentId

        java.lang.String getDeploymentId()
        Returns the specific deployment id on which the associated job was created.
      • getTenantId

        java.lang.String getTenantId()
        Returns the id of the tenant this job log entry belongs to. Can be null if the job log entry belongs to no single tenant.
      • getHostname

        java.lang.String getHostname()
        Returns the name of the host where the Process Engine that added this job log runs.
      • isCreationLog

        boolean isCreationLog()
        Returns true when this log represents the creation of the associated job.
      • isFailureLog

        boolean isFailureLog()
        Returns true when this log represents the failed execution of the associated job.
      • isSuccessLog

        boolean isSuccessLog()
        Returns true when this log represents the successful execution of the associated job.
      • isDeletionLog

        boolean isDeletionLog()
        Returns true when this log represents the deletion of the associated job.
      • getRemovalTime

        java.util.Date getRemovalTime()
        The time the historic job log will be removed.