Package org.camunda.bpm.engine.runtime

Interface CaseExecutionQuery

    • Method Detail

      • caseInstanceId

        CaseExecutionQuery caseInstanceId​(String caseInstanceId)
        Only select case executions which have the given case instance id.
        Parameters:
        caseInstanceId - the id of the case instance
        Throws:
        NotValidException - when the given case instance id is null

      • caseDefinitionId

        CaseExecutionQuery caseDefinitionId​(String caseDefinitionId)
        Only select case executions which have the given case definition id.
        Parameters:
        caseDefinitionId - the id of the case definition
        Throws:
        NotValidException - when the given case definition id is null

      • caseDefinitionKey

        CaseExecutionQuery caseDefinitionKey​(String caseDefinitionKey)
        Only select case executions which have the given case definition key.
        Parameters:
        caseDefinitionKey - the key of the case definition
        Throws:
        NotValidException - when the given case definition key is null

      • caseInstanceBusinessKey

        CaseExecutionQuery caseInstanceBusinessKey​(String caseInstanceBusinessKey)
        Only select case executions that belong to a case instance with the given business key
        Parameters:
        caseInstanceBusinessKey - the business key of the case instance
        Throws:
        NotValidException - when the given case instance business key is null

      • caseExecutionId

        CaseExecutionQuery caseExecutionId​(String executionId)
        Only select case executions with the given id.
        Parameters:
        executionId - the id of the case execution
        Throws:
        NotValidException - when the given case execution id is null

      • activityId

        CaseExecutionQuery activityId​(String activityId)
        Only select case executions which contain an activity with the given id.
        Parameters:
        activityId - the id of the activity
        Throws:
        NotValidException - when the given activity id is null

      • available

        CaseExecutionQuery available()
        Only select case executions which are available.

      • matchVariableNamesIgnoreCase

        CaseExecutionQuery matchVariableNamesIgnoreCase()
        The query will match the names of variables in a case-insensitive way.

      • matchVariableValuesIgnoreCase

        CaseExecutionQuery matchVariableValuesIgnoreCase()
        The query will match the values of variables in a case-insensitive way.

      • variableValueNotEquals

        CaseExecutionQuery variableValueNotEquals​(String name,
                                          Object value)
        Only select case executions which have a local variable with the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable
        Throws:
        NotValidException - when the given name is null

      • variableValueGreaterThan

        CaseExecutionQuery variableValueGreaterThan​(String name,
                                            Object value)
        Only select case executions which have a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • variableValueGreaterThanOrEqual

        CaseExecutionQuery variableValueGreaterThanOrEqual​(String name,
                                                   Object value)
        Only select case executions which have a local variable value greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • variableValueLessThan

        CaseExecutionQuery variableValueLessThan​(String name,
                                         Object value)
        Only select case executions which have a local variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • variableValueLessThanOrEqual

        CaseExecutionQuery variableValueLessThanOrEqual​(String name,
                                                Object value)
        Only select case executions which have a local variable value less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • variableValueLike

        CaseExecutionQuery variableValueLike​(String name,
                                     String value)
        Only select case executions which have a local variable value like the given value. This can be used on string variables only.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • caseInstanceVariableValueEquals

        CaseExecutionQuery caseInstanceVariableValueEquals​(String name,
                                                   Object value)
        Only select case executions which are part of a case instance that have a variable with the given name set to the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableSerializers(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable
        Throws:
        NotValidException - when the given name is null

      • caseInstanceVariableValueNotEquals

        CaseExecutionQuery caseInstanceVariableValueNotEquals​(String name,
                                                      Object value)
        Only select case executions which are part of a case instance that have a variable with the given name, but with a different value than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable
        Throws:
        NotValidException - when the given name is null

      • caseInstanceVariableValueGreaterThan

        CaseExecutionQuery caseInstanceVariableValueGreaterThan​(String name,
                                                        Object value)
        Only select case executions which are part of a case instance that have a variable with the given name and a variable value greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • caseInstanceVariableValueGreaterThanOrEqual

        CaseExecutionQuery caseInstanceVariableValueGreaterThanOrEqual​(String name,
                                                               Object value)
        Only select case executions which are part of a case instance that have a variable value greater than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • caseInstanceVariableValueLessThan

        CaseExecutionQuery caseInstanceVariableValueLessThan​(String name,
                                                     Object value)
        Only select case executions which are part of a case instance that have a variable value less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • caseInstanceVariableValueLessThanOrEqual

        CaseExecutionQuery caseInstanceVariableValueLessThanOrEqual​(String name,
                                                            Object value)
        Only select case executions which are part of a case instance that have a variable value less than or equal to the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • caseInstanceVariableValueLike

        CaseExecutionQuery caseInstanceVariableValueLike​(String name,
                                                 String value)
        Only select case executions which are part of a case instance that have a variable value like the given value. This can be used on string variables only.
        Parameters:
        name - the name of the variable, cannot be null
        value - the value of the variable, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
        Throws:
        NotValidException - when the given name is null or a null-value or a boolean-value is used

      • tenantIdIn

        CaseExecutionQuery tenantIdIn​(String... tenantIds)
        Only select case execution with one of the given tenant ids.

      • withoutTenantId

        CaseExecutionQuery withoutTenantId()
        Only select case executions which have no tenant id.

      • orderByTenantId

        CaseExecutionQuery orderByTenantId()
        Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of case executions without tenant id is database-specific.