Class HistoricDetailDto


  • public class HistoricDetailDto
    extends Object
    HistoricDetailDto
    • Constructor Detail

      • HistoricDetailDto

        public HistoricDetailDto()
    • Method Detail

      • getId

        public String getId()
        The id of the historic detail.
        Returns:
        id
      • setId

        public void setId​(String id)
      • getType

        public String getType()
        The type of the historic detail. Either `formField` for a submitted form field value or `variableUpdate` for variable updates.
        Returns:
        type
      • setType

        public void setType​(String type)
      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        The key of the process definition that this historic detail belongs to.
        Returns:
        processDefinitionKey
      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)
      • getProcessDefinitionId

        public String getProcessDefinitionId()
        The id of the process definition that this historic detail belongs to.
        Returns:
        processDefinitionId
      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)
      • getProcessInstanceId

        public String getProcessInstanceId()
        The id of the process instance the historic detail belongs to.
        Returns:
        processInstanceId
      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)
      • getActivityInstanceId

        public String getActivityInstanceId()
        The id of the activity instance the historic detail belongs to.
        Returns:
        activityInstanceId
      • setActivityInstanceId

        public void setActivityInstanceId​(String activityInstanceId)
      • getExecutionId

        public String getExecutionId()
        The id of the execution the historic detail belongs to.
        Returns:
        executionId
      • setExecutionId

        public void setExecutionId​(String executionId)
      • getCaseDefinitionKey

        public String getCaseDefinitionKey()
        The key of the case definition that this historic detail belongs to.
        Returns:
        caseDefinitionKey
      • setCaseDefinitionKey

        public void setCaseDefinitionKey​(String caseDefinitionKey)
      • getCaseDefinitionId

        public String getCaseDefinitionId()
        The id of the case definition that this historic detail belongs to.
        Returns:
        caseDefinitionId
      • setCaseDefinitionId

        public void setCaseDefinitionId​(String caseDefinitionId)
      • getCaseInstanceId

        public String getCaseInstanceId()
        The id of the case instance the historic detail belongs to.
        Returns:
        caseInstanceId
      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)
      • getCaseExecutionId

        public String getCaseExecutionId()
        The id of the case execution the historic detail belongs to.
        Returns:
        caseExecutionId
      • setCaseExecutionId

        public void setCaseExecutionId​(String caseExecutionId)
      • getTaskId

        public String getTaskId()
        The id of the task the historic detail belongs to.
        Returns:
        taskId
      • setTaskId

        public void setTaskId​(String taskId)
      • getTenantId

        public String getTenantId()
        The id of the tenant that this historic detail belongs to.
        Returns:
        tenantId
      • setTenantId

        public void setTenantId​(String tenantId)
      • getUserOperationId

        public String getUserOperationId()
        The id of user operation which links historic detail with [user operation log](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/) entries.
        Returns:
        userOperationId
      • setUserOperationId

        public void setUserOperationId​(String userOperationId)
      • getTime

        public Date getTime()
        The time when this historic detail occurred. Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
        Returns:
        time
      • setTime

        public void setTime​(Date time)
      • getRemovalTime

        public Date getRemovalTime()
        The time after which the historic detail 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)
      • getRootProcessInstanceId

        public String getRootProcessInstanceId()
        The process instance id of the root process instance that initiated the process containing this historic detail.
        Returns:
        rootProcessInstanceId
      • setRootProcessInstanceId

        public void setRootProcessInstanceId​(String rootProcessInstanceId)
      • getFieldId

        public String getFieldId()
        The id of the form field. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `formField`.
        Returns:
        fieldId
      • setFieldId

        public void setFieldId​(String fieldId)
      • getFieldValue

        public Object getFieldValue()
        The submitted form field value. The value differs depending on the form field's type and on the `deserializeValue` parameter. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `formField`.
        Returns:
        fieldValue
      • setFieldValue

        public void setFieldValue​(Object fieldValue)
      • getVariableName

        public String getVariableName()
        The name of the variable which has been updated. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        variableName
      • setVariableName

        public void setVariableName​(String variableName)
      • getVariableInstanceId

        public String getVariableInstanceId()
        The id of the associated variable instance. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        variableInstanceId
      • setVariableInstanceId

        public void setVariableInstanceId​(String variableInstanceId)
      • getVariableType

        public String getVariableType()
        The value type of the variable. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        variableType
      • setVariableType

        public void setVariableType​(String variableType)
      • getValue

        public Object getValue()
        The variable's value. Value differs depending on the variable's type and on the deserializeValues parameter. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        value
      • setValue

        public void setValue​(Object value)
      • getValueInfo

        public Map<String,​Object> getValueInfo()
        A JSON object containing additional, value-type-dependent properties. For variables of type `Object`, the following properties are returned: * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        valueInfo
      • setValueInfo

        public void setValueInfo​(Map<String,​Object> valueInfo)
      • getInitial

        public Boolean getInitial()
        Returns `true` for variable updates that contains the initial values of the variables. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        initial
      • setInitial

        public void setInitial​(Boolean initial)
      • getRevision

        public Integer getRevision()
        The revision of the historic variable update. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        revision
      • setRevision

        public void setRevision​(Integer revision)
      • getErrorMessage

        public String getErrorMessage()
        An error message in case a Java Serialized Object could not be de-serialized. **Note:** This property is only set for a `HistoricVariableUpdate` historic details. In these cases, the value of the `type` property is `variableUpdate`.
        Returns:
        errorMessage
      • setErrorMessage

        public void setErrorMessage​(String errorMessage)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object