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
:
HistoricJobLog
represents a state in
the lifecycle of a job
.Modifier and Type | Method and Description |
---|---|
String |
getActivityId()
Returns the id of the activity on which the associated job was created.
|
String |
getDeploymentId()
Returns the specific deployment id on which the associated job was created.
|
String |
getExecutionId()
Returns the specific execution id on which the associated job was created.
|
String |
getFailedActivityId()
Returns the id of the activity on which the last exception occurred.
|
String |
getHostname()
Returns the name of the host where the Process Engine that added this job log runs.
|
String |
getId()
Returns the unique identifier for
this historic job log. |
String |
getJobDefinitionConfiguration()
Returns the job definition configuration type of the associated job.
|
String |
getJobDefinitionId()
Returns the id of the job definition on which the associated job was created.
|
String |
getJobDefinitionType()
Returns the job definition type of the associated job.
|
Date |
getJobDueDate()
Returns the due date of the associated job when
this log occurred. |
String |
getJobExceptionMessage()
Returns the message of the exception that occurred by executing the associated job.
|
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. |
String |
getProcessDefinitionId()
Returns the specific process definition id on which the associated job was created.
|
String |
getProcessDefinitionKey()
Returns the specific process definition key on which the associated job was created.
|
String |
getProcessInstanceId()
Returns the specific process instance id on which the associated job was created.
|
Date |
getRemovalTime()
The time the historic job log will be removed.
|
String |
getRootProcessInstanceId()
Returns the specific root process instance id of the process instance
on which the associated job was created.
|
String |
getTenantId()
Returns the id of the tenant this job log entry belongs to.
|
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. |
String getId()
this
historic job log.Date getTimestamp()
this
log occurred.String getJobId()
Date getJobDueDate()
this
log occurred.int getJobRetries()
this
log occurred.long getJobPriority()
this
log entry was created.String getJobExceptionMessage()
HistoryService.getHistoricJobLogExceptionStacktrace(String)
String getJobDefinitionId()
String getJobDefinitionType()
String getJobDefinitionConfiguration()
String getActivityId()
String getFailedActivityId()
String getExecutionId()
String getRootProcessInstanceId()
String getProcessInstanceId()
String getProcessDefinitionId()
String getProcessDefinitionKey()
String getDeploymentId()
String getTenantId()
null
if the job log entry belongs to no single tenant.String getHostname()
boolean isCreationLog()
true
when this
log represents
the creation of the associated job.boolean isFailureLog()
true
when this
log represents
the failed execution of the associated job.boolean isSuccessLog()
true
when this
log represents
the successful execution of the associated job.boolean isDeletionLog()
true
when this
log represents
the deletion of the associated job.Date getRemovalTime()
Copyright © 2021. All rights reserved.