Package org.openapitools.client.model

Class ExecutionQueryDto

  • public class ExecutionQueryDto
extends Object
    A Execution instance query which defines a list of Execution instances

    • Constructor Detail

      • ExecutionQueryDto

        public ExecutionQueryDto()

    • Method Detail

      • getBusinessKey

        public String getBusinessKey()
        Filter by the business key of the process instances the executions belong to.
        Returns:
        businessKey

      • setBusinessKey

        public void setBusinessKey​(String businessKey)

      • getProcessDefinitionId

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

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getProcessDefinitionKey

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

      • setProcessDefinitionKey

        public void setProcessDefinitionKey​(String processDefinitionKey)

      • getProcessInstanceId

        public String getProcessInstanceId()
        Filter by the id of the process instance the execution belongs to.
        Returns:
        processInstanceId

      • setProcessInstanceId

        public void setProcessInstanceId​(String processInstanceId)

      • getActivityId

        public String getActivityId()
        Filter by the id of the activity the execution currently executes.
        Returns:
        activityId

      • setActivityId

        public void setActivityId​(String activityId)

      • signalEventSubscriptionName

        public ExecutionQueryDto signalEventSubscriptionName​(String signalEventSubscriptionName)

      • getSignalEventSubscriptionName

        public String getSignalEventSubscriptionName()
        Select only those executions that expect a signal of the given name.
        Returns:
        signalEventSubscriptionName

      • setSignalEventSubscriptionName

        public void setSignalEventSubscriptionName​(String signalEventSubscriptionName)

      • messageEventSubscriptionName

        public ExecutionQueryDto messageEventSubscriptionName​(String messageEventSubscriptionName)

      • getMessageEventSubscriptionName

        public String getMessageEventSubscriptionName()
        Select only those executions that expect a message of the given name.
        Returns:
        messageEventSubscriptionName

      • setMessageEventSubscriptionName

        public void setMessageEventSubscriptionName​(String messageEventSubscriptionName)

      • getActive

        public Boolean getActive()
        Only include active executions. Value may only be `true`, as `false` is the default behavior.
        Returns:
        active

      • setActive

        public void setActive​(Boolean active)

      • getSuspended

        public Boolean getSuspended()
        Only include suspended executions. Value may only be `true`, as `false` is the default behavior.
        Returns:
        suspended

      • setSuspended

        public void setSuspended​(Boolean suspended)

      • getIncidentId

        public String getIncidentId()
        Filter by the incident id.
        Returns:
        incidentId

      • setIncidentId

        public void setIncidentId​(String incidentId)

      • getIncidentType

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

      • setIncidentType

        public void setIncidentType​(String incidentType)

      • 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)

      • getTenantIdIn

        public List<String> getTenantIdIn()
        Filter by a list of tenant ids. An execution must have one of the given tenant ids.
        Returns:
        tenantIdIn

      • setTenantIdIn

        public void setTenantIdIn​(List<String> tenantIdIn)

      • getVariables

        public List<VariableQueryParameterDto> getVariables()
        An array to only include executions that have 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

      • getProcessVariables

        public List<VariableQueryParameterDto> getProcessVariables()
        An array to only include executions that belong to a process instance with 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.
        Returns:
        processVariables

      • getVariableNamesIgnoreCase

        public Boolean getVariableNamesIgnoreCase()
        Match all variable names provided in `variables` and `processVariables` 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` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal.
        Returns:
        variableValuesIgnoreCase

      • setVariableValuesIgnoreCase

        public void setVariableValuesIgnoreCase​(Boolean variableValuesIgnoreCase)

      • getSorting

        public List<ExecutionQueryDtoSorting> getSorting()
        An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Has no effect for the `/count` endpoint
        Returns:
        sorting

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object