Package org.camunda.bpm.engine.history
Interface HistoricJobLog
- 
- All Known Implementing Classes:
- HistoricJobLogEventEntity
 
 public interface HistoricJobLogThe HistoricJobLogis used to have a log containing information aboutjobexecution. The log provides details about the complete lifecycle of ajob:- job created
- job execution failed
- job execution successful
- job was deleted
 HistoricJobLogrepresents a state in the lifecycle of ajob.- Since:
- 7.3
- Author:
- Roman Smirnov
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetActivityId()Returns the id of the activity on which the associated job was created.java.lang.StringgetDeploymentId()Returns the specific deployment id on which the associated job was created.java.lang.StringgetExecutionId()Returns the specific execution id on which the associated job was created.java.lang.StringgetFailedActivityId()Returns the id of the activity on which the last exception occurred.java.lang.StringgetHostname()Returns the name of the host where the Process Engine that added this job log runs.java.lang.StringgetId()Returns the unique identifier forthishistoric job log.java.lang.StringgetJobDefinitionConfiguration()Returns the job definition configuration type of the associated job.java.lang.StringgetJobDefinitionId()Returns the id of the job definition on which the associated job was created.java.lang.StringgetJobDefinitionType()Returns the job definition type of the associated job.java.util.DategetJobDueDate()Returns the due date of the associated job whenthislog occurred.java.lang.StringgetJobExceptionMessage()Returns the message of the exception that occurred by executing the associated job.java.lang.StringgetJobId()Returns the id of the associated job.longgetJobPriority()Returns the priority of the associated job whenthislog entry was created.intgetJobRetries()Returns the retries of the associated job before the associated job has been executed and whenthislog occurred.java.lang.StringgetProcessDefinitionId()Returns the specific process definition id on which the associated job was created.java.lang.StringgetProcessDefinitionKey()Returns the specific process definition key on which the associated job was created.java.lang.StringgetProcessInstanceId()Returns the specific process instance id on which the associated job was created.java.util.DategetRemovalTime()The time the historic job log will be removed.java.lang.StringgetRootProcessInstanceId()Returns the specific root process instance id of the process instance on which the associated job was created.java.lang.StringgetTenantId()Returns the id of the tenant this job log entry belongs to.java.util.DategetTimestamp()Returns the time whenthislog occurred.booleanisCreationLog()Returnstruewhenthislog represents the creation of the associated job.booleanisDeletionLog()Returnstruewhenthislog represents the deletion of the associated job.booleanisFailureLog()Returnstruewhenthislog represents the failed execution of the associated job.booleanisSuccessLog()Returnstruewhenthislog represents the successful execution of the associated job.
 
- 
- 
- 
Method Detail- 
getIdjava.lang.String getId() Returns the unique identifier forthishistoric job log.
 - 
getTimestampjava.util.Date getTimestamp() Returns the time whenthislog occurred.
 - 
getJobIdjava.lang.String getJobId() Returns the id of the associated job.
 - 
getJobDueDatejava.util.Date getJobDueDate() Returns the due date of the associated job whenthislog occurred.
 - 
getJobRetriesint getJobRetries() Returns the retries of the associated job before the associated job has been executed and whenthislog occurred.
 - 
getJobPrioritylong getJobPriority() Returns the priority of the associated job whenthislog entry was created.- Since:
- 7.4
 
 - 
getJobExceptionMessagejava.lang.String getJobExceptionMessage() Returns the message of the exception that occurred by executing the associated job. To get the full exception stacktrace, useHistoryService.getHistoricJobLogExceptionStacktrace(String)
 - 
getJobDefinitionIdjava.lang.String getJobDefinitionId() Returns the id of the job definition on which the associated job was created.
 - 
getJobDefinitionTypejava.lang.String getJobDefinitionType() Returns the job definition type of the associated job.
 - 
getJobDefinitionConfigurationjava.lang.String getJobDefinitionConfiguration() Returns the job definition configuration type of the associated job.
 - 
getActivityIdjava.lang.String getActivityId() Returns the id of the activity on which the associated job was created.
 - 
getFailedActivityIdjava.lang.String getFailedActivityId() Returns the id of the activity on which the last exception occurred.
 - 
getExecutionIdjava.lang.String getExecutionId() Returns the specific execution id on which the associated job was created.
 - 
getRootProcessInstanceIdjava.lang.String getRootProcessInstanceId() Returns the specific root process instance id of the process instance on which the associated job was created.
 - 
getProcessInstanceIdjava.lang.String getProcessInstanceId() Returns the specific process instance id on which the associated job was created.
 - 
getProcessDefinitionIdjava.lang.String getProcessDefinitionId() Returns the specific process definition id on which the associated job was created.
 - 
getProcessDefinitionKeyjava.lang.String getProcessDefinitionKey() Returns the specific process definition key on which the associated job was created.
 - 
getDeploymentIdjava.lang.String getDeploymentId() Returns the specific deployment id on which the associated job was created.
 - 
getTenantIdjava.lang.String getTenantId() Returns the id of the tenant this job log entry belongs to. Can benullif the job log entry belongs to no single tenant.
 - 
getHostnamejava.lang.String getHostname() Returns the name of the host where the Process Engine that added this job log runs.
 - 
isCreationLogboolean isCreationLog() Returnstruewhenthislog represents the creation of the associated job.
 - 
isFailureLogboolean isFailureLog() Returnstruewhenthislog represents the failed execution of the associated job.
 - 
isSuccessLogboolean isSuccessLog() Returnstruewhenthislog represents the successful execution of the associated job.
 - 
isDeletionLogboolean isDeletionLog() Returnstruewhenthislog represents the deletion of the associated job.
 - 
getRemovalTimejava.util.Date getRemovalTime() The time the historic job log will be removed.
 
- 
 
-