Package org.camunda.bpm.engine.runtime

Interface VariableInstanceQuery

    • Method Detail

      • variableId

        VariableInstanceQuery variableId​(java.lang.String id)
        Only select the variable with the given Id
        Parameters:
        the - id of the variable to select
        Returns:
        the query object

      • variableName

        VariableInstanceQuery variableName​(java.lang.String variableName)
        Only select variable instances which have the variable name.

      • variableNameIn

        VariableInstanceQuery variableNameIn​(java.lang.String... variableNames)
        Only select variable instances which have one of the variables names.

      • variableNameLike

        VariableInstanceQuery variableNameLike​(java.lang.String variableNameLike)
        Only select variable instances which have the name like the assigned variable name. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

      • executionIdIn

        VariableInstanceQuery executionIdIn​(java.lang.String... executionIds)
        Only select variable instances which have one of the executions ids.

      • processInstanceIdIn

        VariableInstanceQuery processInstanceIdIn​(java.lang.String... processInstanceIds)
        Only select variable instances which have one of the process instance ids.

      • caseExecutionIdIn

        VariableInstanceQuery caseExecutionIdIn​(java.lang.String... caseExecutionIds)
        Only select variable instances which have one of the case execution ids.

      • caseInstanceIdIn

        VariableInstanceQuery caseInstanceIdIn​(java.lang.String... caseInstanceIds)
        Only select variable instances which have one of the case instance ids.

      • taskIdIn

        VariableInstanceQuery taskIdIn​(java.lang.String... taskIds)
        Only select variable instances which have one of the task ids.

      • batchIdIn

        VariableInstanceQuery batchIdIn​(java.lang.String... batchIds)
        Only select variable instances which are related to one of the given batch ids.

      • variableScopeIdIn

        VariableInstanceQuery variableScopeIdIn​(java.lang.String... variableScopeIds)
        Only select variables instances which have on of the variable scope ids.

      • activityInstanceIdIn

        VariableInstanceQuery activityInstanceIdIn​(java.lang.String... activityInstanceIds)
        Only select variable instances which have one of the activity instance ids.

      • variableValueEquals

        VariableInstanceQuery variableValueEquals​(java.lang.String name,
                                          java.lang.Object value)
        Only select variables instances which have the given name and 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 - name of the variable, cannot be null.
        value - variable value, can be null.

      • variableValueNotEquals

        VariableInstanceQuery variableValueNotEquals​(java.lang.String name,
                                             java.lang.Object value)
        Only select variable instances which have 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 - name of the variable, cannot be null.
        value - variable value, can be null.

      • variableValueGreaterThan

        VariableInstanceQuery variableValueGreaterThan​(java.lang.String name,
                                               java.lang.Object value)
        Only select variable instances which value is greater than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - variable name, cannot be null.
        value - variable value, cannot be null.

      • variableValueGreaterThanOrEqual

        VariableInstanceQuery variableValueGreaterThanOrEqual​(java.lang.String name,
                                                      java.lang.Object value)
        Only select variable instances which value is 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 - variable name, cannot be null.
        value - variable value, cannot be null.

      • variableValueLessThan

        VariableInstanceQuery variableValueLessThan​(java.lang.String name,
                                            java.lang.Object value)
        Only select variable instances which value is less than the passed value. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - variable name, cannot be null.
        value - variable value, cannot be null.

      • variableValueLessThanOrEqual

        VariableInstanceQuery variableValueLessThanOrEqual​(java.lang.String name,
                                                   java.lang.Object value)
        Only select variable instances which value is 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 - variable name, cannot be null.
        value - variable value, cannot be null.

      • disableBinaryFetching

        VariableInstanceQuery disableBinaryFetching()
        Disable fetching of byte array and file values. By default, the query will fetch such values. By calling this method you can prevent the values of (potentially large) blob data chunks to be fetched. The variables themselves are nonetheless included in the query result.
        Returns:
        the query builder

      • disableCustomObjectDeserialization

        VariableInstanceQuery disableCustomObjectDeserialization()
        Disable deserialization of variable values that are custom objects. By default, the query will attempt to deserialize the value of these variables. By calling this method you can prevent such attempts in environments where their classes are not available. Independent of this setting, variable serialized values are accessible.

      • variableValueLike

        VariableInstanceQuery variableValueLike​(java.lang.String name,
                                        java.lang.String value)
        Only select variable instances which value is like the given value. This be used on string variables only.
        Parameters:
        name - variable name, cannot be null.
        value - variable value, cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).

      • tenantIdIn

        VariableInstanceQuery tenantIdIn​(java.lang.String... tenantIds)
        Only select variable instances with one of the given tenant ids.