Package org.openapitools.client.model

Class HistoricProcessInstanceQueryDto

  • public class HistoricProcessInstanceQueryDto
extends Object
    A historic process instance query which defines a group of historic process instances

    • Constructor Detail

      • HistoricProcessInstanceQueryDto

        public HistoricProcessInstanceQueryDto()

    • Method Detail

      • getProcessInstanceId

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

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • getProcessInstanceIds

        public List<String> getProcessInstanceIds()
        Filter by process instance ids. Must be a JSON array of `Strings`.
        Returns:
        processInstanceIds

      • setProcessInstanceIds

        public void setProcessInstanceIds​(List<String> processInstanceIds)

      • getProcessDefinitionId

        public String getProcessDefinitionId()
        Filter by the process definition the instances run on.
        Returns:
        processDefinitionId

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionKey

        public String getProcessDefinitionKey()
        Filter by the key of the process definition the instances run on.
        Returns:
        processDefinitionKey

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getProcessDefinitionKeyIn

        public List<String> getProcessDefinitionKeyIn()
        Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of `Strings`.
        Returns:
        processDefinitionKeyIn

      • setProcessDefinitionKeyIn

        public void setProcessDefinitionKeyIn​(List<String> processDefinitionKeyIn)

      • getProcessDefinitionName

        public String getProcessDefinitionName()
        Filter by the name of the process definition the instances run on.
        Returns:
        processDefinitionName

      • setProcessDefinitionName

        public void setProcessDefinitionName​(String processDefinitionName)

      • getProcessDefinitionNameLike

        public String getProcessDefinitionNameLike()
        Filter by process definition names that the parameter is a substring of.
        Returns:
        processDefinitionNameLike

      • setProcessDefinitionNameLike

        public void setProcessDefinitionNameLike​(String processDefinitionNameLike)

      • getProcessDefinitionKeyNotIn

        public List<String> getProcessDefinitionKeyNotIn()
        Exclude instances that belong to a set of process definitions. Must be a JSON array of `Strings`.
        Returns:
        processDefinitionKeyNotIn

      • setProcessDefinitionKeyNotIn

        public void setProcessDefinitionKeyNotIn​(List<String> processDefinitionKeyNotIn)

      • getProcessInstanceBusinessKey

        public String getProcessInstanceBusinessKey()
        Filter by process instance business key.
        Returns:
        processInstanceBusinessKey

      • setProcessInstanceBusinessKey

        public void setProcessInstanceBusinessKey​(String processInstanceBusinessKey)

      • getProcessInstanceBusinessKeyIn

        public List<String> getProcessInstanceBusinessKeyIn()
        Filter by a list of business keys. A process instance must have one of the given business keys. Must be a JSON array of `Strings`
        Returns:
        processInstanceBusinessKeyIn

      • setProcessInstanceBusinessKeyIn

        public void setProcessInstanceBusinessKeyIn​(List<String> processInstanceBusinessKeyIn)

      • getProcessInstanceBusinessKeyLike

        public String getProcessInstanceBusinessKeyLike()
        Filter by process instance business key that the parameter is a substring of.
        Returns:
        processInstanceBusinessKeyLike

      • setProcessInstanceBusinessKeyLike

        public void setProcessInstanceBusinessKeyLike​(String processInstanceBusinessKeyLike)

      • getRootProcessInstances

        public Boolean getRootProcessInstances()
        Restrict the query to all process instances that are top level process instances.
        Returns:
        rootProcessInstances

      • setRootProcessInstances

        public void setRootProcessInstances​(Boolean rootProcessInstances)

      • getFinished

        public Boolean getFinished()
        Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior.
        Returns:
        finished

      • setFinished

        public void setFinished​(Boolean finished)

      • getUnfinished

        public Boolean getUnfinished()
        Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior.
        Returns:
        unfinished

      • setUnfinished

        public void setUnfinished​(Boolean unfinished)

      • getWithIncidents

        public Boolean getWithIncidents()
        Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withIncidents

      • setWithIncidents

        public void setWithIncidents​(Boolean withIncidents)

      • getWithRootIncidents

        public Boolean getWithRootIncidents()
        Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior.
        Returns:
        withRootIncidents

      • setWithRootIncidents

        public void setWithRootIncidents​(Boolean withRootIncidents)

      • getIncidentType

        public String getIncidentType()
        Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
        Returns:
        incidentType

      • setIncidentType

        public void setIncidentType​(String incidentType)

      • getIncidentStatus

        public HistoricProcessInstanceQueryDto.IncidentStatusEnum getIncidentStatus()
        Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents.
        Returns:
        incidentStatus

      • getIncidentMessage

        public String getIncidentMessage()
        Filter by the incident message. Exact match.
        Returns:
        incidentMessage

      • setIncidentMessage

        public void setIncidentMessage​(String incidentMessage)

      • getIncidentMessageLike

        public String getIncidentMessageLike()
        Filter by the incident message that the parameter is a substring of.
        Returns:
        incidentMessageLike

      • setIncidentMessageLike

        public void setIncidentMessageLike​(String incidentMessageLike)

      • getStartedBefore

        public Date getStartedBefore()
        Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        startedBefore

      • setStartedBefore

        public void setStartedBefore​(Date startedBefore)

      • getStartedAfter

        public Date getStartedAfter()
        Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        startedAfter

      • setStartedAfter

        public void setStartedAfter​(Date startedAfter)

      • getFinishedBefore

        public Date getFinishedBefore()
        Restrict to instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        finishedBefore

      • setFinishedBefore

        public void setFinishedBefore​(Date finishedBefore)

      • getFinishedAfter

        public Date getFinishedAfter()
        Restrict to instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        finishedAfter

      • setFinishedAfter

        public void setFinishedAfter​(Date finishedAfter)

      • getExecutedActivityAfter

        public Date getExecutedActivityAfter()
        Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        executedActivityAfter

      • setExecutedActivityAfter

        public void setExecutedActivityAfter​(Date executedActivityAfter)

      • getExecutedActivityBefore

        public Date getExecutedActivityBefore()
        Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        executedActivityBefore

      • setExecutedActivityBefore

        public void setExecutedActivityBefore​(Date executedActivityBefore)

      • getExecutedJobAfter

        public Date getExecutedJobAfter()
        Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        executedJobAfter

      • setExecutedJobAfter

        public void setExecutedJobAfter​(Date executedJobAfter)

      • getExecutedJobBefore

        public Date getExecutedJobBefore()
        Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`.
        Returns:
        executedJobBefore

      • setExecutedJobBefore

        public void setExecutedJobBefore​(Date executedJobBefore)

      • getStartedBy

        public String getStartedBy()
        Only include process instances that were started by the given user.
        Returns:
        startedBy

      • setStartedBy

        public void setStartedBy​(String startedBy)

      • getSuperProcessInstanceId

        public String getSuperProcessInstanceId()
        Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
        Returns:
        superProcessInstanceId

      • setSuperProcessInstanceId

        public void setSuperProcessInstanceId​(String superProcessInstanceId)

      • getSubProcessInstanceId

        public String getSubProcessInstanceId()
        Restrict query to one process instance that has a sub process instance with the given id.
        Returns:
        subProcessInstanceId

      • setSubProcessInstanceId

        public void setSubProcessInstanceId​(String subProcessInstanceId)

      • getSuperCaseInstanceId

        public String getSuperCaseInstanceId()
        Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
        Returns:
        superCaseInstanceId

      • setSuperCaseInstanceId

        public void setSuperCaseInstanceId​(String superCaseInstanceId)

      • getSubCaseInstanceId

        public String getSubCaseInstanceId()
        Restrict query to one process instance that has a sub case instance with the given id.
        Returns:
        subCaseInstanceId

      • setSubCaseInstanceId

        public void setSubCaseInstanceId​(String subCaseInstanceId)

      • getCaseInstanceId

        public String getCaseInstanceId()
        Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
        Returns:
        caseInstanceId

      • setCaseInstanceId

        public void setCaseInstanceId​(String caseInstanceId)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of `Strings`
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getWithoutTenantId

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

      • setWithoutTenantId

        public void setWithoutTenantId​(Boolean withoutTenantId)

      • getExecutedActivityIdIn

        public List<String> getExecutedActivityIdIn()
        Restrict to instances that executed an activity with one of given ids. Must be a JSON array of `Strings`
        Returns:
        executedActivityIdIn

      • setExecutedActivityIdIn

        public void setExecutedActivityIdIn​(List<String> executedActivityIdIn)

      • getActiveActivityIdIn

        public List<String> getActiveActivityIdIn()
        Restrict to instances that have an active activity with one of given ids. Must be a JSON array of `Strings`
        Returns:
        activeActivityIdIn

      • setActiveActivityIdIn

        public void setActiveActivityIdIn​(List<String> activeActivityIdIn)

      • getActive

        public Boolean getActive()
        Restrict to instances that are active.
        Returns:
        active

      • setActive

        public void setActive​(Boolean active)

      • getSuspended

        public Boolean getSuspended()
        Restrict to instances that are suspended.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • getCompleted

        public Boolean getCompleted()
        Restrict to instances that are completed.
        Returns:
        completed

      • setCompleted

        public void setCompleted​(Boolean completed)

      • getExternallyTerminated

        public Boolean getExternallyTerminated()
        Restrict to instances that are externallyTerminated.
        Returns:
        externallyTerminated

      • setExternallyTerminated

        public void setExternallyTerminated​(Boolean externallyTerminated)

      • getInternallyTerminated

        public Boolean getInternallyTerminated()
        Restrict to instances that are internallyTerminated.
        Returns:
        internallyTerminated

      • setInternallyTerminated

        public void setInternallyTerminated​(Boolean internallyTerminated)

      • getVariables

        public List<VariableQueryParameterDto> getVariables()
        A JSON array to only include process instances that have/had variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (`String`) is the variable name, `operator` (`String`) is the comparison operator to be used and `value` the variable value. Value may be `String`, `Number` or `Boolean`. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`.
        Returns:
        variables

      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal.
        Returns:
        variableNamesIgnoreCase

      • setVariableNamesIgnoreCase

        public void setVariableNamesIgnoreCase​(Boolean variableNamesIgnoreCase)

      • getVariableValuesIgnoreCase

        public Boolean getVariableValuesIgnoreCase()
        Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal.
        Returns:
        variableValuesIgnoreCase

      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)

      • getOrQueries

        public List<HistoricProcessInstanceQueryDto> getOrQueries()
        A JSON array of nested historic process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query ([Conjunctive Normal Form](https://en.wikipedia.org/wiki/Conjunctive_normal_form)). All process instance query properties can be used except for: `sorting` See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
        Returns:
        orQueries

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object