Interface HistoricProcessInstanceQuery

    • Method Detail

      • processDefinitionId

        HistoricProcessInstanceQuery processDefinitionId​(String processDefinitionId)
        Only select historic process instances for the given process definition
      • processDefinitionKey

        HistoricProcessInstanceQuery processDefinitionKey​(String processDefinitionKey)
        Only select historic process instances that are defined by a process definition with the given key.
      • processDefinitionKeyIn

        HistoricProcessInstanceQuery processDefinitionKeyIn​(List<String> processDefinitionKeys)
        Only select historic process instances that are defined by a process definition with one of the given process definition keys.
      • processDefinitionKeyNotIn

        HistoricProcessInstanceQuery processDefinitionKeyNotIn​(List<String> processDefinitionKeys)
        Only select historic process instances that don't have a process-definition of which the key is present in the given list
      • processDefinitionCategory

        HistoricProcessInstanceQuery processDefinitionCategory​(String processDefinitionCategory)
        Only select historic process instances whose process definition category is processDefinitionCategory.
      • processDefinitionName

        HistoricProcessInstanceQuery processDefinitionName​(String processDefinitionName)
        Select process historic instances whose process definition name is processDefinitionName
      • processInstanceBusinessKey

        HistoricProcessInstanceQuery processInstanceBusinessKey​(String processInstanceBusinessKey)
        Only select historic process instances with the given business key
      • processInstanceBusinessKeyLike

        HistoricProcessInstanceQuery processInstanceBusinessKeyLike​(String businessKeyLike)
        Only select historic process instances with a business key like the given value.
      • deploymentId

        HistoricProcessInstanceQuery deploymentId​(String deploymentId)
        Only select historic process instances that are defined by a process definition with the given deployment identifier.
      • deploymentIdIn

        HistoricProcessInstanceQuery deploymentIdIn​(List<String> deploymentIds)
        Only select historic process instances that are defined by a process definition with one of the given deployment identifiers.
      • activeActivityId

        HistoricProcessInstanceQuery activeActivityId​(String activityId)
        Select the historic process instances which have an active activity instance like the provided id.
      • activeActivityIds

        HistoricProcessInstanceQuery activeActivityIds​(Set<String> activityIds)
        Select the historic process instances which have an active activity instance like the provided ids.
      • involvedUser

        HistoricProcessInstanceQuery involvedUser​(String userId)
        Only select the historic process instances with which the user with the given id is involved.
      • involvedUser

        HistoricProcessInstanceQuery involvedUser​(String userId,
                                                  String identityLinkType)
        Only select the historic process instances with which the user with the given id and link type is involved.
      • involvedGroup

        HistoricProcessInstanceQuery involvedGroup​(String groupId,
                                                   String identityLinkType)
        Only select the historic process instances with which the group with the given id and link type is involved.
      • variableValueEquals

        HistoricProcessInstanceQuery variableValueEquals​(String name,
                                                         Object value)
        Only select process instances which had a global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! A variable type is determined based on the value, using types configured in ProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - of the variable, cannot be null.
      • variableValueEquals

        HistoricProcessInstanceQuery variableValueEquals​(Object value)
        Only select process instances which had at least one global variable with the given value when they ended. The type only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! A variable type is determined based on the value, using types configured in ProcessEngineConfigurationImpl.getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
      • variableValueEqualsIgnoreCase

        HistoricProcessInstanceQuery variableValueEqualsIgnoreCase​(String name,
                                                                   String value)
        Only select historic process instances which have a local string variable with the given value, case insensitive.
        Parameters:
        name - name of the variable, cannot be null.
        value - value of the variable, cannot be null.
      • variableValueNotEquals

        HistoricProcessInstanceQuery variableValueNotEquals​(String name,
                                                            Object value)
        Only select process instances which had a global variable with the given name, but with a different value than the passed value when they ended. Only select process instances which have a variable value greater than the passed value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - of the variable, cannot be null.
      • variableValueGreaterThan

        HistoricProcessInstanceQuery variableValueGreaterThan​(String name,
                                                              Object value)
        Only select process instances which had a global variable value greater than the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only select process instances which have a variable value greater than the passed value.
        Parameters:
        name - cannot be null.
        value - cannot be null.
      • variableValueGreaterThanOrEqual

        HistoricProcessInstanceQuery variableValueGreaterThanOrEqual​(String name,
                                                                     Object value)
        Only select process instances which had a global variable value greater than or equal to the passed value when they ended. Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead!
        Parameters:
        name - cannot be null.
        value - cannot be null.
      • variableValueLessThan

        HistoricProcessInstanceQuery variableValueLessThan​(String name,
                                                           Object value)
        Only select process instances which had a global variable value less than the passed value when the ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - cannot be null.
        value - cannot be null.
      • variableValueLessThanOrEqual

        HistoricProcessInstanceQuery variableValueLessThanOrEqual​(String name,
                                                                  Object value)
        Only select process instances which has a global variable value less than or equal to the passed value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! Booleans, Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.
        Parameters:
        name - cannot be null.
        value - cannot be null.
      • variableValueLike

        HistoricProcessInstanceQuery variableValueLike​(String name,
                                                       String value)
        Only select process instances which had global variable value like the given value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! This can be used on string variables only.
        Parameters:
        name - cannot be null.
        value - cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
      • variableValueLikeIgnoreCase

        HistoricProcessInstanceQuery variableValueLikeIgnoreCase​(String name,
                                                                 String value)
        Only select process instances which had global variable value like (case insensitive) the given value when they ended. Only applies to already ended process instances, otherwise use a ProcessInstanceQuery instead! This can be used on string variables only.
        Parameters:
        name - cannot be null.
        value - cannot be null. The string can include the wildcard character '%' to express like-strategy: starts with (string%), ends with (%string) or contains (%string%).
      • variableExists

        HistoricProcessInstanceQuery variableExists​(String name)
        Only select process instances which have a variable with the given name.
        Parameters:
        name - cannot be null.
      • variableNotExists

        HistoricProcessInstanceQuery variableNotExists​(String name)
        Only select process instances which does not have a variable with the given name.
        Parameters:
        name - cannot be null.
      • processInstanceTenantIdLike

        HistoricProcessInstanceQuery processInstanceTenantIdLike​(String tenantIdLike)
        Only select process instances with a tenant id like the given one.
      • processInstanceWithoutTenantId

        HistoricProcessInstanceQuery processInstanceWithoutTenantId()
        Only select process instances that do not have a tenant id.
      • or

        HistoricProcessInstanceQuery or()
        Begin an OR statement. Make sure you invoke the endOr method at the end of your OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.
      • endOr

        HistoricProcessInstanceQuery endOr()
        End an OR statement. Only one OR statement is allowed, for the second call to this method an exception will be thrown.
      • orderByProcessInstanceId

        HistoricProcessInstanceQuery orderByProcessInstanceId()
        Order by the process instance id (needs to be followed by Query.asc() or Query.desc()).
      • orderByProcessDefinitionId

        HistoricProcessInstanceQuery orderByProcessDefinitionId()
        Order by the process definition id (needs to be followed by Query.asc() or Query.desc()).
      • orderByProcessInstanceBusinessKey

        HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()
        Order by the business key (needs to be followed by Query.asc() or Query.desc()).
      • orderByProcessInstanceStartTime

        HistoricProcessInstanceQuery orderByProcessInstanceStartTime()
        Order by the start time (needs to be followed by Query.asc() or Query.desc()).
      • orderByProcessInstanceEndTime

        HistoricProcessInstanceQuery orderByProcessInstanceEndTime()
        Order by the end time (needs to be followed by Query.asc() or Query.desc()).
      • orderByProcessInstanceDuration

        HistoricProcessInstanceQuery orderByProcessInstanceDuration()
        Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()).
      • excludeSubprocesses

        HistoricProcessInstanceQuery excludeSubprocesses​(boolean excludeSubprocesses)
        Exclude sub processes from the query result;
      • withJobException

        HistoricProcessInstanceQuery withJobException()
        Only select process instances that failed due to an exception happening during a job execution.
      • processInstanceNameLikeIgnoreCase

        HistoricProcessInstanceQuery processInstanceNameLikeIgnoreCase​(String nameLikeIgnoreCase)
        Only select process instances with a name like the given value, ignoring upper/lower case.
      • processInstanceCallbackId

        HistoricProcessInstanceQuery processInstanceCallbackId​(String callbackId)
        Only select process instances with the given callback identifier.
      • processInstanceCallbackType

        HistoricProcessInstanceQuery processInstanceCallbackType​(String callbackType)
        Only select process instances with the given callback type.
      • processInstanceReferenceId

        HistoricProcessInstanceQuery processInstanceReferenceId​(String referenceId)
        Only select process instances with the given reference identifier.
      • processInstanceReferenceType

        HistoricProcessInstanceQuery processInstanceReferenceType​(String referenceType)
        Only select process instances with the given reference type.
      • withLocalizationFallback

        HistoricProcessInstanceQuery withLocalizationFallback()
        Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.