Package org.openapitools.client.model

Class HistoricProcessInstanceDto

  • public class HistoricProcessInstanceDto
extends Object
    HistoricProcessInstanceDto

    • Constructor Detail

      • HistoricProcessInstanceDto

        public HistoricProcessInstanceDto()

    • Method Detail

      • getId

        public String getId()
        The id of the process instance.
        Returns:
        id

      • setId

        public void setId​(String id)

      • getRootProcessInstanceId

        public String getRootProcessInstanceId()
        The process instance id of the root process instance that initiated the process.
        Returns:
        rootProcessInstanceId

      • setRootProcessInstanceId

        public void setRootProcessInstanceId​(String rootProcessInstanceId)

      • getSuperProcessInstanceId

        public String getSuperProcessInstanceId()
        The id of the parent process instance, if it exists.
        Returns:
        superProcessInstanceId

      • setSuperProcessInstanceId

        public void setSuperProcessInstanceId​(String superProcessInstanceId)

      • getSuperCaseInstanceId

        public String getSuperCaseInstanceId()
        The id of the parent case instance, if it exists.
        Returns:
        superCaseInstanceId

      • setSuperCaseInstanceId

        public void setSuperCaseInstanceId​(String superCaseInstanceId)

      • getCaseInstanceId

        public String getCaseInstanceId()
        The id of the parent case instance, if it exists.
        Returns:
        caseInstanceId

      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)

      • getProcessDefinitionName

        public String getProcessDefinitionName()
        The name of the process definition that this process instance belongs to.
        Returns:
        processDefinitionName

      • setProcessDefinitionName

        public void setProcessDefinitionName​(String processDefinitionName)

      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        The key of the process definition that this process instance belongs to.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getProcessDefinitionVersion

        public Integer getProcessDefinitionVersion()
        The version of the process definition that this process instance belongs to.
        Returns:
        processDefinitionVersion

      • setProcessDefinitionVersion

        public void setProcessDefinitionVersion​(Integer processDefinitionVersion)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        The id of the process definition that this process instance belongs to.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getBusinessKey

        public String getBusinessKey()
        The business key of the process instance.
        Returns:
        businessKey

      • setBusinessKey

        public void setBusinessKey​(String businessKey)

      • getStartTime

        public Date getStartTime()
        The time the instance was started. Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        Returns:
        startTime

      • setStartTime

        public void setStartTime​(Date startTime)

      • getEndTime

        public Date getEndTime()
        The time the instance ended. Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        Returns:
        endTime

      • setEndTime

        public void setEndTime​(Date endTime)

      • getRemovalTime

        public Date getRemovalTime()
        The time after which the instance should be removed by the History Cleanup job. Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        Returns:
        removalTime

      • setRemovalTime

        public void setRemovalTime​(Date removalTime)

      • getDurationInMillis

        public Long getDurationInMillis()
        The time the instance took to finish (in milliseconds).
        Returns:
        durationInMillis

      • setDurationInMillis

        public void setDurationInMillis​(Long durationInMillis)

      • getStartUserId

        public String getStartUserId()
        The id of the user who started the process instance.
        Returns:
        startUserId

      • setStartUserId

        public void setStartUserId​(String startUserId)

      • getStartActivityId

        public String getStartActivityId()
        The id of the initial activity that was executed (e.g., a start event).
        Returns:
        startActivityId

      • setStartActivityId

        public void setStartActivityId​(String startActivityId)

      • getDeleteReason

        public String getDeleteReason()
        The provided delete reason in case the process instance was canceled during execution.
        Returns:
        deleteReason

      • setDeleteReason

        public void setDeleteReason​(String deleteReason)

      • getTenantId

        public String getTenantId()
        The tenant id of the process instance.
        Returns:
        tenantId

      • setTenantId

        public void setTenantId​(String tenantId)

      • getState

        public HistoricProcessInstanceDto.StateEnum getState()
        Last state of the process instance, possible values are: `ACTIVE` - running process instance `SUSPENDED` - suspended process instances `COMPLETED` - completed through normal end event `EXTERNALLY_TERMINATED` - terminated externally, for instance through REST API `INTERNALLY_TERMINATED` - terminated internally, for instance by terminating boundary event
        Returns:
        state

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object