Package org.camunda.bpm.engine.history
Interface HistoricJobLog
-
- All Known Implementing Classes:
HistoricJobLogEventEntity
public interface HistoricJobLog
The
HistoricJobLog
is used to have a log containing information aboutjob
execution. The log provides details about the complete lifecycle of ajob
:- job created
- job execution failed
- job execution successful
- job was deleted
HistoricJobLog
represents a state in the lifecycle of ajob
.- 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 forthis
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 whenthis
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 whenthis
log entry was created.int
getJobRetries()
Returns the retries of the associated job before the associated job has been executed and whenthis
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 whenthis
log occurred.boolean
isCreationLog()
Returnstrue
whenthis
log represents the creation of the associated job.boolean
isDeletionLog()
Returnstrue
whenthis
log represents the deletion of the associated job.boolean
isFailureLog()
Returnstrue
whenthis
log represents the failed execution of the associated job.boolean
isSuccessLog()
Returnstrue
whenthis
log represents the successful execution of the associated job.
-
-
-
Method Detail
-
getId
java.lang.String getId()
Returns the unique identifier forthis
historic job log.
-
getTimestamp
java.util.Date getTimestamp()
Returns the time whenthis
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 whenthis
log occurred.
-
getJobRetries
int getJobRetries()
Returns the retries of the associated job before the associated job has been executed and whenthis
log occurred.
-
getJobPriority
long getJobPriority()
Returns the priority of the associated job whenthis
log entry was created.- Since:
- 7.4
-
getJobExceptionMessage
java.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)
-
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 benull
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()
Returnstrue
whenthis
log represents the creation of the associated job.
-
isFailureLog
boolean isFailureLog()
Returnstrue
whenthis
log represents the failed execution of the associated job.
-
isSuccessLog
boolean isSuccessLog()
Returnstrue
whenthis
log represents the successful execution of the associated job.
-
isDeletionLog
boolean isDeletionLog()
Returnstrue
whenthis
log represents the deletion of the associated job.
-
getRemovalTime
java.util.Date getRemovalTime()
The time the historic job log will be removed.
-
-