Package org.camunda.bpm.engine.runtime

Interface CaseInstanceQuery

All Superinterfaces:
Query<CaseInstanceQuery,CaseInstance>
All Known Implementing Classes:
CaseInstanceQueryImpl
public interface CaseInstanceQuery extends Query<CaseInstanceQuery,CaseInstance>
Author:
Roman Smirnov

  • Method Details

    • caseInstanceId

      CaseInstanceQuery caseInstanceId(String caseInstanceId)
      Select the case instance with the given id
      Parameters:
      caseInstanceId - the id of the case instance
      Throws:
      NotValidException - when the given case instance id is null

    • caseInstanceBusinessKey

      CaseInstanceQuery caseInstanceBusinessKey(String caseInstanceBusinessKey)
      Select case instances 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

    • caseDefinitionKey

      CaseInstanceQuery caseDefinitionKey(String caseDefinitionKey)
      Select the case instances which are defined by a case definition with the given key.
      Parameters:
      caseDefinitionKey - the key of the case definition
      Throws:
      NotValidException - when the given case definition key is null

    • caseDefinitionId

      CaseInstanceQuery caseDefinitionId(String caseDefinitionId)
      Selects the case instances which are defined by a case definition with the given id.
      Parameters:
      caseDefinitionId - the id of the case definition
      Throws:
      NotValidException - when the given case definition id is null

    • deploymentId

      CaseInstanceQuery deploymentId(String deploymentId)
      Selects the case instances which belong to the given deployment id.
      Since:
      7.4

    • superProcessInstanceId

      CaseInstanceQuery superProcessInstanceId(String superProcessInstanceId)
      Select the case instances which are a sub case instance of the given super process instance.
      Since:
      7.3

    • subProcessInstanceId

      CaseInstanceQuery subProcessInstanceId(String subProcessInstanceId)
      Select the case instance that has as sub process instance the given process instance. Note that there will always be at most one such case instance that can be the result of this query.
      Since:
      7.3

    • superCaseInstanceId

      CaseInstanceQuery superCaseInstanceId(String superCaseInstanceId)
      Select the case instances which are a sub case instance of the given super case instance.
      Since:
      7.3

    • subCaseInstanceId

      CaseInstanceQuery subCaseInstanceId(String subCaseInstanceId)
      Select the case instance that has as sub case instance the given case instance. Note that there will always be at most one such process instance that can be the result of this query.
      Since:
      7.3

    • active

      CaseInstanceQuery active()
      Only select case instances which are active.

    • completed

      CaseInstanceQuery completed()
      Only select case instances which are completed.

    • terminated

      CaseInstanceQuery terminated()
      Only select case instances which are terminated.

    • matchVariableNamesIgnoreCase

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

    • matchVariableValuesIgnoreCase

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

    • variableValueEquals

      CaseInstanceQuery variableValueEquals(String name, Object value)
      Only select cases instances which have a global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfigurationImpl.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

    • variableValueNotEquals

      CaseInstanceQuery variableValueNotEquals(String name, Object value)
      Only select cases instances which have a global 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 - name of the variable, cannot be null
      value - the value of the variable
      Throws:
      NotValidException - when the given name is null

    • variableValueGreaterThan

      CaseInstanceQuery variableValueGreaterThan(String name, Object value)
      Only select cases instances which have a global variable value 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
      Throws:
      NotValidException - when the given name is null or a null-value or a boolean-value is used

    • variableValueGreaterThanOrEqual

      CaseInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
      Only select cases instances which have a global 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 - variable name, cannot be null
      value - variable value, cannot be null
      Throws:
      NotValidException - when the given name is null or a null-value or a boolean-value is used

    • variableValueLessThan

      CaseInstanceQuery variableValueLessThan(String name, Object value)
      Only select cases instances which have a global variable value 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
      Throws:
      NotValidException - when the given name is null or a null-value or a boolean-value is used

    • variableValueLessThanOrEqual

      CaseInstanceQuery variableValueLessThanOrEqual(String name, Object value)
      Only select cases instances which have a global 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 - variable name, cannot be null
      value - variable value, cannot be null
      Throws:
      NotValidException - when the given name is null or a null-value or a boolean-value is used

    • variableValueLike

      CaseInstanceQuery variableValueLike(String name, String value)
      Only select cases instances which have a global variable value like the given value. This can 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%).
      Throws:
      NotValidException - when the given name is null or a null-value or a boolean-value is used

    • variableValueNotLike

      CaseInstanceQuery variableValueNotLike(String name, String value)
      Only select case instances which have a global variable with the given name and not matching the given value. The syntax is that of SQL: for example usage: valueNotLike(%value%)
      Parameters:
      name - the name of the variable
      value - the value of the variable, it can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string), contains (%string%)
      Throws:
      NotValidException - if the name or value is null or a null-value or a boolean-value is used

    • tenantIdIn

      CaseInstanceQuery tenantIdIn(String... tenantIds)
      Only select case instances with one of the given tenant ids.

    • withoutTenantId

      CaseInstanceQuery withoutTenantId()
      Only select case instances which have no tenant id.

    • orderByCaseInstanceId

      CaseInstanceQuery orderByCaseInstanceId()
      Order by id (needs to be followed by Query.asc() or Query.desc()).

    • orderByCaseDefinitionKey

      CaseInstanceQuery orderByCaseDefinitionKey()
      Order by case definition key (needs to be followed by Query.asc() or Query.desc()).

    • orderByCaseDefinitionId

      CaseInstanceQuery orderByCaseDefinitionId()
      Order by case definition id (needs to be followed by Query.asc() or Query.desc()).

    • orderByTenantId

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