Package org.camunda.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 Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      Returns the id of the activity of the process instance on which this incident has happened.
      java.lang.String getAnnotation()
      Returns the annotation of this incident
      java.lang.String getCauseIncidentId()
      Returns the id of the incident on which this incident has been triggered.
      java.lang.String getConfiguration()
      Returns the payload of this incident.
      java.util.Date getCreateTime()
      Time when the incident happened.
      java.util.Date getEndTime()
      Time when the incident has been resolved or deleted.
      java.lang.String getExecutionId()
      Returns the specific execution on which this incident has happened.
      java.lang.String getFailedActivityId()
      Returns the id of the activity on which the last exception occurred.
      java.lang.String getHistoryConfiguration()
      Returns the history payload of this incident.
      java.lang.String getId()
      Returns the unique identifier for this incident.
      java.lang.String getIncidentMessage()
      Returns the incident message.
      java.lang.String getIncidentType()
      Returns the type of this incident to identify the kind of incident.
      java.lang.String getJobDefinitionId()
      Returns the id of the job definition the incident belongs to.
      java.lang.String getProcessDefinitionId()
      Returns the id of the process definition of this process instance on which the incident has happened.
      java.lang.String getProcessDefinitionKey()
      Returns the key of the process definition of this process instance on which the incident has happened.
      java.lang.String getProcessInstanceId()
      Returns the specific process instance on which this incident has happened.
      java.util.Date getRemovalTime()
      The time the historic incident will be removed.
      java.lang.String getRootCauseIncidentId()
      Returns the id of the root incident on which this transitive incident has been triggered.
      java.lang.String getRootProcessInstanceId()
      Returns the specific root process instance id of the process instance on which this incident has happened.
      java.lang.String getTenantId()
      Returns the id of the tenant this incident belongs to.
      boolean isDeleted()
      Returns true, iff the corresponding incident has been deleted.
      boolean isOpen()
      Returns true, iff the corresponding incident has not been deleted or resolved.
      boolean isResolved()
      Returns true, iff the corresponding incident has been resolved.

    • Method Detail

      • getId

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

      • getCreateTime

        java.util.Date getCreateTime()
        Time when the incident happened.

      • getEndTime

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

      • getIncidentType

        java.lang.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

        java.lang.String getIncidentMessage()
        Returns the incident message.

      • getExecutionId

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

      • getActivityId

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

      • getRootProcessInstanceId

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

      • getProcessInstanceId

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

      • getProcessDefinitionId

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

      • getProcessDefinitionKey

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

      • getCauseIncidentId

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

      • getRootCauseIncidentId

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

      • getConfiguration

        java.lang.String getConfiguration()
        Returns the payload of this incident.

      • getHistoryConfiguration

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

      • isOpen

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

      • isDeleted

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

      • isResolved

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

      • getTenantId

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

      • getJobDefinitionId

        java.lang.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

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

      • getFailedActivityId

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

      • getAnnotation

        java.lang.String getAnnotation()
        Returns the annotation of this incident