Package org.openapitools.client.model

Class HistoricDetailQueryDto

  • public class HistoricDetailQueryDto
extends Object
    A historic detail query which defines a group of historic details.

    • Constructor Detail

      • HistoricDetailQueryDto

        public HistoricDetailQueryDto()

    • Method Detail

      • getProcessInstanceId

        public String getProcessInstanceId()
        Filter by process instance id.
        Returns:
        processInstanceId

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • getProcessInstanceIdIn

        public List<String> getProcessInstanceIdIn()
        Only include historic details which belong to one of the passed process instance ids.
        Returns:
        processInstanceIdIn

      • setProcessInstanceIdIn

        public void setProcessInstanceIdIn​(List<String> processInstanceIdIn)

      • getExecutionId

        public String getExecutionId()
        Filter by execution id.
        Returns:
        executionId

      • setExecutionId

        public void setExecutionId​(String executionId)

      • getTaskId

        public String getTaskId()
        Filter by task id.
        Returns:
        taskId

      • setTaskId

        public void setTaskId​(String taskId)

      • getActivityInstanceId

        public String getActivityInstanceId()
        Filter by activity instance id.
        Returns:
        activityInstanceId

      • setActivityInstanceId

        public void setActivityInstanceId​(String activityInstanceId)

      • getCaseInstanceId

        public String getCaseInstanceId()
        Filter by case instance id.
        Returns:
        caseInstanceId

      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)

      • getCaseExecutionId

        public String getCaseExecutionId()
        Filter by case execution id.
        Returns:
        caseExecutionId

      • setCaseExecutionId

        public void setCaseExecutionId​(String caseExecutionId)

      • getVariableInstanceId

        public String getVariableInstanceId()
        Filter by variable instance id.
        Returns:
        variableInstanceId

      • setVariableInstanceId

        public void setVariableInstanceId​(String variableInstanceId)

      • getVariableTypeIn

        public List<String> getVariableTypeIn()
        Only include historic details where the variable updates belong to one of the passed list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`.
        Returns:
        variableTypeIn

      • setVariableTypeIn

        public void setVariableTypeIn​(List<String> variableTypeIn)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a list of tenant ids.
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getWithoutTenantId

        public Boolean getWithoutTenantId()
        Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withoutTenantId

      • setWithoutTenantId

        public void setWithoutTenantId​(Boolean withoutTenantId)

      • getUserOperationId

        public String getUserOperationId()
        Filter by a user operation id.
        Returns:
        userOperationId

      • setUserOperationId

        public void setUserOperationId​(String userOperationId)

      • getFormFields

        public Boolean getFormFields()
        Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior.
        Returns:
        formFields

      • setFormFields

        public void setFormFields​(Boolean formFields)

      • getVariableUpdates

        public Boolean getVariableUpdates()
        Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior.
        Returns:
        variableUpdates

      • setVariableUpdates

        public void setVariableUpdates​(Boolean variableUpdates)

      • getExcludeTaskDetails

        public Boolean getExcludeTaskDetails()
        Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior.
        Returns:
        excludeTaskDetails

      • setExcludeTaskDetails

        public void setExcludeTaskDetails​(Boolean excludeTaskDetails)

      • getInitial

        public Boolean getInitial()
        Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior.
        Returns:
        initial

      • setInitial

        public void setInitial​(Boolean initial)

      • getOccurredBefore

        public Date getOccurredBefore()
        Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
        Returns:
        occurredBefore

      • setOccurredBefore

        public void setOccurredBefore​(Date occurredBefore)

      • getOccurredAfter

        public Date getOccurredAfter()
        Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200.
        Returns:
        occurredAfter

      • setOccurredAfter

        public void setOccurredAfter​(Date occurredAfter)

      • getSorting

        public List<HistoricDetailQueryDtoSorting> getSorting()
        A JSON array of criteria to sort the result by. Each element of the array is a JSON object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Does not have an effect for the `count` endpoint.
        Returns:
        sorting

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object