Incident (camunda BPM Javadocs 7.8.0-SNAPSHOT)

All Known Implementing Classes:

IncidentEntity
```
public interface Incident
```
An Incident represents a failure in the execution of a process instance.
A possible failure could be for example a failed Job during the execution, so that the job retry is equal zero (job.retries == 0). In that case an incident will be created an the incidentType will be set to failedJobs.
Furthermore, it is possible to create custom incidents with an individually incidentType to indicate a failure in the execution.

Author:

roman.smirnov

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXTERNAL_TASK_HANDLER_TYPE` Handler type for incidents created on external task failure
`static String`	`FAILED_JOB_HANDLER_TYPE` Handler type for incidents created on job execution failure

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getActivityId()` Returns the id of the activity of the process instance on which this incident has happened.
`String`	`getCauseIncidentId()` Returns the id of the incident on which this incident has been triggered.
`String`	`getConfiguration()` Returns the payload of this incident.
`String`	`getExecutionId()` Returns the specific execution on which this incident has happened.
`String`	`getId()` Returns the unique identifier for this incident.
`String`	`getIncidentMessage()` Returns the incident message.
`Date`	`getIncidentTimestamp()` Time when the incident happened.
`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`	`getProcessInstanceId()` Returns the specific process instance on which this incident has happened.
`String`	`getRootCauseIncidentId()` Returns the id of the root incident on which this transitive incident has been triggered.
`String`	`getTenantId()` Returns the id of the tenant this incident belongs to.

- Field Detail
  - FAILED_JOB_HANDLER_TYPE
```
static final String FAILED_JOB_HANDLER_TYPE
```
    Handler type for incidents created on job execution failure
    
    See Also:
    Constant Field Values
  - EXTERNAL_TASK_HANDLER_TYPE
```
static final String EXTERNAL_TASK_HANDLER_TYPE
```
    Handler type for incidents created on external task failure
    
    See Also:
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Returns the unique identifier for this incident.
  - getIncidentTimestamp
```
Date getIncidentTimestamp()
```
    Time when the incident happened.
  - 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.
    
    See Also:
    FAILED_JOB_HANDLER_TYPE, EXTERNAL_TASK_HANDLER_TYPE
  - 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.
  - 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.
  - 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.
  - getTenantId
```
String getTenantId()
```
    Returns the id of the tenant this incident belongs to. Can be null if the incident belongs to no single tenant.
  - getJobDefinitionId
```
String getJobDefinitionId()
```
    Returns the id of the job definition the incident belongs to. Can be null if the incident belongs to no job definition.

Interface Incident

Field Summary

Method Summary

Field Detail

FAILED_JOB_HANDLER_TYPE

EXTERNAL_TASK_HANDLER_TYPE

Method Detail

getId

getIncidentTimestamp

getIncidentType

getIncidentMessage

getExecutionId

getActivityId

getProcessInstanceId

getProcessDefinitionId

getCauseIncidentId

getRootCauseIncidentId

getConfiguration

getTenantId

getJobDefinitionId