Package org.camunda.bpm.engine.history
Interface HistoricIncident
-
- All Known Implementing Classes:
HistoricIncidentEntity
public interface HistoricIncident
Represents a historicincident
that is stored permanently.- Author:
- Roman Smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getActivityId()
Returns the id of the activity of the process instance on which this incident has happened.String
getAnnotation()
Returns the annotation of this incidentString
getCauseIncidentId()
Returns the id of the incident on which this incident has been triggered.String
getConfiguration()
Returns the payload of this incident.Date
getCreateTime()
Time when the incident happened.Date
getEndTime()
Time when the incident has been resolved or deleted.String
getExecutionId()
Returns the specific execution on which this incident has happened.String
getFailedActivityId()
Returns the id of the activity on which the last exception occurred.String
getHistoryConfiguration()
Returns the history payload of this incident.String
getId()
Returns the unique identifier for this incident.String
getIncidentMessage()
Returns the incident message.String
getIncidentType()
Returns the type of this incident to identify the kind of incident.String
getJobDefinitionId()
Returns the id of the job definition the incident belongs to.String
getProcessDefinitionId()
Returns the id of the process definition of this process instance on which the incident has happened.String
getProcessDefinitionKey()
Returns the key of the process definition of this process instance on which the incident has happened.String
getProcessInstanceId()
Returns the specific process instance on which this incident has happened.Date
getRemovalTime()
The time the historic incident will be removed.String
getRootCauseIncidentId()
Returns the id of the root incident on which this transitive incident has been triggered.String
getRootProcessInstanceId()
Returns the specific root process instance id of the process instance on which this incident has happened.String
getTenantId()
Returns the id of the tenant this incident belongs to.boolean
isDeleted()
Returnstrue
, iff the corresponding incident has been deleted.boolean
isOpen()
Returnstrue
, iff the corresponding incident has not been deleted or resolved.boolean
isResolved()
Returnstrue
, iff the corresponding incident has been resolved.
-
-
-
Method Detail
-
getId
String getId()
Returns the unique identifier for this incident.
-
getCreateTime
Date getCreateTime()
Time when the incident happened.
-
getEndTime
Date getEndTime()
Time when the incident has been resolved or deleted.
-
getIncidentType
String getIncidentType()
Returns the type of this incident to identify the kind of incident.For example:
failedJobs
will be returned in the case of an incident, which identify failed job during the execution of a process instance.
-
getIncidentMessage
String getIncidentMessage()
Returns the incident message.
-
getExecutionId
String getExecutionId()
Returns the specific execution on which this incident has happened.
-
getActivityId
String getActivityId()
Returns the id of the activity of the process instance on which this incident has happened.
-
getRootProcessInstanceId
String getRootProcessInstanceId()
Returns the specific root process instance id of the process instance on which this incident has happened.
-
getProcessInstanceId
String getProcessInstanceId()
Returns the specific process instance on which this incident has happened.
-
getProcessDefinitionId
String getProcessDefinitionId()
Returns the id of the process definition of this process instance on which the incident has happened.
-
getProcessDefinitionKey
String getProcessDefinitionKey()
Returns the key of the process definition of this process instance on which the incident has happened.
-
getCauseIncidentId
String getCauseIncidentId()
Returns the id of the incident on which this incident has been triggered.
-
getRootCauseIncidentId
String getRootCauseIncidentId()
Returns the id of the root incident on which this transitive incident has been triggered.
-
getConfiguration
String getConfiguration()
Returns the payload of this incident.
-
getHistoryConfiguration
String getHistoryConfiguration()
Returns the history payload of this incident.
-
isOpen
boolean isOpen()
Returnstrue
, iff the corresponding incident has not been deleted or resolved.
-
isDeleted
boolean isDeleted()
Returnstrue
, iff the corresponding incident has been deleted.
-
isResolved
boolean isResolved()
Returnstrue
, iff the corresponding incident has been resolved.
-
getTenantId
String getTenantId()
Returns the id of the tenant this incident belongs to. Can benull
if the incident belongs to no single tenant.
-
getJobDefinitionId
String getJobDefinitionId()
Returns the id of the job definition the incident belongs to. Can benull
if the incident belongs to no job definition.
-
getRemovalTime
Date getRemovalTime()
The time the historic incident will be removed.
-
getFailedActivityId
String getFailedActivityId()
Returns the id of the activity on which the last exception occurred.
-
getAnnotation
String getAnnotation()
Returns the annotation of this incident
-
-