Package org.openapitools.client.model
Class HistoricDetailDto
- java.lang.Object
-
- org.openapitools.client.model.HistoricDetailDto
-
public class HistoricDetailDto extends Object
HistoricDetailDto
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description HistoricDetailDto()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HistoricDetailDtoactivityInstanceId(String activityInstanceId)HistoricDetailDtocaseDefinitionId(String caseDefinitionId)HistoricDetailDtocaseDefinitionKey(String caseDefinitionKey)HistoricDetailDtocaseExecutionId(String caseExecutionId)HistoricDetailDtocaseInstanceId(String caseInstanceId)booleanequals(Object o)HistoricDetailDtoerrorMessage(String errorMessage)HistoricDetailDtoexecutionId(String executionId)HistoricDetailDtofieldId(String fieldId)HistoricDetailDtofieldValue(Object fieldValue)StringgetActivityInstanceId()The id of the activity instance the historic detail belongs to.StringgetCaseDefinitionId()The id of the case definition that this historic detail belongs to.StringgetCaseDefinitionKey()The key of the case definition that this historic detail belongs to.StringgetCaseExecutionId()The id of the case execution the historic detail belongs to.StringgetCaseInstanceId()The id of the case instance the historic detail belongs to.StringgetErrorMessage()An error message in case a Java Serialized Object could not be de-serialized.StringgetExecutionId()The id of the execution the historic detail belongs to.StringgetFieldId()The id of the form field.ObjectgetFieldValue()The submitted form field value.StringgetId()The id of the historic detail.BooleangetInitial()Returns `true` for variable updates that contains the initial values of the variables.StringgetProcessDefinitionId()The id of the process definition that this historic detail belongs to.StringgetProcessDefinitionKey()The key of the process definition that this historic detail belongs to.StringgetProcessInstanceId()The id of the process instance the historic detail belongs to.DategetRemovalTime()The time after which the historic detail should be removed by the History Cleanup job.IntegergetRevision()The revision of the historic variable update.StringgetRootProcessInstanceId()The process instance id of the root process instance that initiated the process containing this historic detail.StringgetTaskId()The id of the task the historic detail belongs to.StringgetTenantId()The id of the tenant that this historic detail belongs to.DategetTime()The time when this historic detail occurred.StringgetType()The type of the historic detail.StringgetUserOperationId()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.ObjectgetValue()The variable's value.Map<String,Object>getValueInfo()A JSON object containing additional, value-type-dependent properties.StringgetVariableInstanceId()The id of the associated variable instance.StringgetVariableName()The name of the variable which has been updated.StringgetVariableType()The value type of the variable.inthashCode()HistoricDetailDtoid(String id)HistoricDetailDtoinitial(Boolean initial)HistoricDetailDtoprocessDefinitionId(String processDefinitionId)HistoricDetailDtoprocessDefinitionKey(String processDefinitionKey)HistoricDetailDtoprocessInstanceId(String processInstanceId)HistoricDetailDtoputValueInfoItem(String key, Object valueInfoItem)HistoricDetailDtoremovalTime(Date removalTime)HistoricDetailDtorevision(Integer revision)HistoricDetailDtorootProcessInstanceId(String rootProcessInstanceId)voidsetActivityInstanceId(String activityInstanceId)voidsetCaseDefinitionId(String caseDefinitionId)voidsetCaseDefinitionKey(String caseDefinitionKey)voidsetCaseExecutionId(String caseExecutionId)voidsetCaseInstanceId(String caseInstanceId)voidsetErrorMessage(String errorMessage)voidsetExecutionId(String executionId)voidsetFieldId(String fieldId)voidsetFieldValue(Object fieldValue)voidsetId(String id)voidsetInitial(Boolean initial)voidsetProcessDefinitionId(String processDefinitionId)voidsetProcessDefinitionKey(String processDefinitionKey)voidsetProcessInstanceId(String processInstanceId)voidsetRemovalTime(Date removalTime)voidsetRevision(Integer revision)voidsetRootProcessInstanceId(String rootProcessInstanceId)voidsetTaskId(String taskId)voidsetTenantId(String tenantId)voidsetTime(Date time)voidsetType(String type)voidsetUserOperationId(String userOperationId)voidsetValue(Object value)voidsetValueInfo(Map<String,Object> valueInfo)voidsetVariableInstanceId(String variableInstanceId)voidsetVariableName(String variableName)voidsetVariableType(String variableType)HistoricDetailDtotaskId(String taskId)HistoricDetailDtotenantId(String tenantId)HistoricDetailDtotime(Date time)StringtoString()HistoricDetailDtotype(String type)HistoricDetailDtouserOperationId(String userOperationId)HistoricDetailDtovalue(Object value)HistoricDetailDtovalueInfo(Map<String,Object> valueInfo)HistoricDetailDtovariableInstanceId(String variableInstanceId)HistoricDetailDtovariableName(String variableName)HistoricDetailDtovariableType(String variableType)
-
-
-
Field Detail
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TYPE
public static final String SERIALIZED_NAME_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESS_DEFINITION_KEY
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESS_DEFINITION_ID
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESS_INSTANCE_ID
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXECUTION_ID
public static final String SERIALIZED_NAME_EXECUTION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_DEFINITION_KEY
public static final String SERIALIZED_NAME_CASE_DEFINITION_KEY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_DEFINITION_ID
public static final String SERIALIZED_NAME_CASE_DEFINITION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_INSTANCE_ID
public static final String SERIALIZED_NAME_CASE_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CASE_EXECUTION_ID
public static final String SERIALIZED_NAME_CASE_EXECUTION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TASK_ID
public static final String SERIALIZED_NAME_TASK_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TENANT_ID
public static final String SERIALIZED_NAME_TENANT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_USER_OPERATION_ID
public static final String SERIALIZED_NAME_USER_OPERATION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIME
public static final String SERIALIZED_NAME_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REMOVAL_TIME
public static final String SERIALIZED_NAME_REMOVAL_TIME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID
public static final String SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FIELD_ID
public static final String SERIALIZED_NAME_FIELD_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FIELD_VALUE
public static final String SERIALIZED_NAME_FIELD_VALUE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VARIABLE_NAME
public static final String SERIALIZED_NAME_VARIABLE_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VARIABLE_INSTANCE_ID
public static final String SERIALIZED_NAME_VARIABLE_INSTANCE_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VARIABLE_TYPE
public static final String SERIALIZED_NAME_VARIABLE_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALUE
public static final String SERIALIZED_NAME_VALUE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALUE_INFO
public static final String SERIALIZED_NAME_VALUE_INFO
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_INITIAL
public static final String SERIALIZED_NAME_INITIAL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REVISION
public static final String SERIALIZED_NAME_REVISION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ERROR_MESSAGE
public static final String SERIALIZED_NAME_ERROR_MESSAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
id
public HistoricDetailDto id(String id)
-
getId
public String getId()
The id of the historic detail.- Returns:
- id
-
setId
public void setId(String id)
-
type
public HistoricDetailDto type(String type)
-
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)
-
processDefinitionKey
public HistoricDetailDto processDefinitionKey(String processDefinitionKey)
-
getProcessDefinitionKey
public String getProcessDefinitionKey()
The key of the process definition that this historic detail belongs to.- Returns:
- processDefinitionKey
-
setProcessDefinitionKey
public void setProcessDefinitionKey(String processDefinitionKey)
-
processDefinitionId
public HistoricDetailDto processDefinitionId(String processDefinitionId)
-
getProcessDefinitionId
public String getProcessDefinitionId()
The id of the process definition that this historic detail belongs to.- Returns:
- processDefinitionId
-
setProcessDefinitionId
public void setProcessDefinitionId(String processDefinitionId)
-
processInstanceId
public HistoricDetailDto processInstanceId(String processInstanceId)
-
getProcessInstanceId
public String getProcessInstanceId()
The id of the process instance the historic detail belongs to.- Returns:
- processInstanceId
-
setProcessInstanceId
public void setProcessInstanceId(String processInstanceId)
-
activityInstanceId
public HistoricDetailDto activityInstanceId(String activityInstanceId)
-
getActivityInstanceId
public String getActivityInstanceId()
The id of the activity instance the historic detail belongs to.- Returns:
- activityInstanceId
-
setActivityInstanceId
public void setActivityInstanceId(String activityInstanceId)
-
executionId
public HistoricDetailDto executionId(String executionId)
-
getExecutionId
public String getExecutionId()
The id of the execution the historic detail belongs to.- Returns:
- executionId
-
setExecutionId
public void setExecutionId(String executionId)
-
caseDefinitionKey
public HistoricDetailDto caseDefinitionKey(String caseDefinitionKey)
-
getCaseDefinitionKey
public String getCaseDefinitionKey()
The key of the case definition that this historic detail belongs to.- Returns:
- caseDefinitionKey
-
setCaseDefinitionKey
public void setCaseDefinitionKey(String caseDefinitionKey)
-
caseDefinitionId
public HistoricDetailDto caseDefinitionId(String caseDefinitionId)
-
getCaseDefinitionId
public String getCaseDefinitionId()
The id of the case definition that this historic detail belongs to.- Returns:
- caseDefinitionId
-
setCaseDefinitionId
public void setCaseDefinitionId(String caseDefinitionId)
-
caseInstanceId
public HistoricDetailDto caseInstanceId(String caseInstanceId)
-
getCaseInstanceId
public String getCaseInstanceId()
The id of the case instance the historic detail belongs to.- Returns:
- caseInstanceId
-
setCaseInstanceId
public void setCaseInstanceId(String caseInstanceId)
-
caseExecutionId
public HistoricDetailDto caseExecutionId(String caseExecutionId)
-
getCaseExecutionId
public String getCaseExecutionId()
The id of the case execution the historic detail belongs to.- Returns:
- caseExecutionId
-
setCaseExecutionId
public void setCaseExecutionId(String caseExecutionId)
-
taskId
public HistoricDetailDto taskId(String taskId)
-
getTaskId
public String getTaskId()
The id of the task the historic detail belongs to.- Returns:
- taskId
-
setTaskId
public void setTaskId(String taskId)
-
tenantId
public HistoricDetailDto tenantId(String tenantId)
-
getTenantId
public String getTenantId()
The id of the tenant that this historic detail belongs to.- Returns:
- tenantId
-
setTenantId
public void setTenantId(String tenantId)
-
userOperationId
public HistoricDetailDto userOperationId(String userOperationId)
-
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)
-
time
public HistoricDetailDto time(Date time)
-
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)
-
removalTime
public HistoricDetailDto removalTime(Date removalTime)
-
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)
-
rootProcessInstanceId
public HistoricDetailDto rootProcessInstanceId(String rootProcessInstanceId)
-
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)
-
fieldId
public HistoricDetailDto fieldId(String fieldId)
-
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)
-
fieldValue
public HistoricDetailDto fieldValue(Object fieldValue)
-
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)
-
variableName
public HistoricDetailDto variableName(String variableName)
-
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)
-
variableInstanceId
public HistoricDetailDto variableInstanceId(String variableInstanceId)
-
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)
-
variableType
public HistoricDetailDto variableType(String variableType)
-
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)
-
value
public HistoricDetailDto value(Object value)
-
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)
-
valueInfo
public HistoricDetailDto valueInfo(Map<String,Object> valueInfo)
-
putValueInfoItem
public HistoricDetailDto putValueInfoItem(String key, Object valueInfoItem)
-
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
-
initial
public HistoricDetailDto initial(Boolean initial)
-
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)
-
revision
public HistoricDetailDto revision(Integer revision)
-
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)
-
errorMessage
public HistoricDetailDto errorMessage(String errorMessage)
-
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)
-
-