Package org.eximeebpms.bpm.engine.history

Interface HistoricIncident

All Known Implementing Classes:
HistoricIncidentEntity
public interface HistoricIncident
Represents a historic incident that is stored permanently.
Author:
Roman Smirnov

  • Method Details Link icon

    • getId Link icon

      String getId()
      Returns the unique identifier for this incident.

    • getCreateTime Link icon

      Date getCreateTime()
      Time when the incident happened.

    • getEndTime Link icon

      Date getEndTime()
      Time when the incident has been resolved or deleted.

    • getIncidentType Link icon

      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 Link icon

      String getIncidentMessage()
      Returns the incident message.

    • getExecutionId Link icon

      String getExecutionId()
      Returns the specific execution on which this incident has happened.

    • getActivityId Link icon

      String getActivityId()
      Returns the id of the activity of the process instance on which this incident has happened.

    • getRootProcessInstanceId Link icon

      String getRootProcessInstanceId()
      Returns the specific root process instance id of the process instance on which this incident has happened.

    • getProcessInstanceId Link icon

      String getProcessInstanceId()
      Returns the specific process instance on which this incident has happened.

    • getProcessDefinitionId Link icon

      String getProcessDefinitionId()
      Returns the id of the process definition of this process instance on which the incident has happened.

    • getProcessDefinitionKey Link icon

      String getProcessDefinitionKey()
      Returns the key of the process definition of this process instance on which the incident has happened.

    • getCauseIncidentId Link icon

      String getCauseIncidentId()
      Returns the id of the incident on which this incident has been triggered.

    • getRootCauseIncidentId Link icon

      String getRootCauseIncidentId()
      Returns the id of the root incident on which this transitive incident has been triggered.

    • getConfiguration Link icon

      String getConfiguration()
      Returns the payload of this incident.

    • getHistoryConfiguration Link icon

      String getHistoryConfiguration()
      Returns the history payload of this incident.

    • isOpen Link icon

      boolean isOpen()
      Returns true, iff the corresponding incident has not been deleted or resolved.

    • isDeleted Link icon

      boolean isDeleted()
      Returns true, iff the corresponding incident has been deleted.

    • isResolved Link icon

      boolean isResolved()
      Returns true, iff the corresponding incident has been resolved.

    • getTenantId Link icon

      String getTenantId()
      Returns the id of the tenant this incident belongs to. Can be null if the incident belongs to no single tenant.

    • getJobDefinitionId Link icon

      String getJobDefinitionId()
      Returns the id of the job definition the incident belongs to. Can be null if the incident belongs to no job definition.

    • getRemovalTime Link icon

      Date getRemovalTime()
      The time the historic incident will be removed.

    • getFailedActivityId Link icon

      String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.

    • getAnnotation Link icon

      String getAnnotation()
      Returns the annotation of this incident