org.activiti.engine.runtime
接口 ProcessInstanceQuery

所有超级接口:
Query<ProcessInstanceQuery,ProcessInstance>
所有已知实现类:
ProcessInstanceQueryImpl

public interface ProcessInstanceQuery
extends Query<ProcessInstanceQuery,ProcessInstance>

Allows programmatic querying of ProcessInstances.

作者:
Joram Barrez, Frederik Heremans, Falko Menge

方法摘要
 ProcessInstanceQuery active()
          Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.
 ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
          Exclude sub processes from the query result;
 ProcessInstanceQuery includeProcessVariables()
          Include process variables in the process query result
 ProcessInstanceQuery involvedUser(String userId)
          Select the process instances with which the user with the given id is involved.
 ProcessInstanceQuery orderByProcessDefinitionId()
          Order by process definition id (needs to be followed by Query.asc() or Query.desc()).
 ProcessInstanceQuery orderByProcessDefinitionKey()
          Order by process definition key (needs to be followed by Query.asc() or Query.desc()).
 ProcessInstanceQuery orderByProcessInstanceId()
          Order by id (needs to be followed by Query.asc() or Query.desc()).
 ProcessInstanceQuery processDefinitionId(String processDefinitionId)
          Select the process instances which are defined by a process definition with the given id.
 ProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
          Select the process instances which are defined by a process definition with the given key.
 ProcessInstanceQuery processDefinitionName(String processDefinitionName)
          Select process instances whose process definition name is processDefinitionName
 ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
          Select process instances with the given business key
 ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey, String processDefinitionKey)
          Select process instance with the given business key, unique for the given process definition
 ProcessInstanceQuery processInstanceId(String processInstanceId)
          Select the process instance with the given id
 ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
          Select process instances whose id is in the given set of ids
 ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
          Select the process instance that have as sub process instance the given process instance.
 ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
          Select the process instances which are a sub process instance of the given super process instance.
 ProcessInstanceQuery suspended()
          Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended
 ProcessInstanceQuery variableValueEquals(Object value)
          Only select process instances which have at least one global variable with the given value.
 ProcessInstanceQuery variableValueEquals(String name, Object value)
          Only select process instances which have a global variable with the given value.
 ProcessInstanceQuery variableValueEqualsIgnoreCase(String name, String value)
          Only select process instances which have a local string variable with the given value, case insensitive.
 ProcessInstanceQuery variableValueGreaterThan(String name, Object value)
          Only select process instances which have a variable value greater than the passed value.
 ProcessInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
          Only select process instances which have a global variable value greater than or equal to the passed value.
 ProcessInstanceQuery variableValueLessThan(String name, Object value)
          Only select process instances which have a global variable value less than the passed value.
 ProcessInstanceQuery variableValueLessThanOrEqual(String name, Object value)
          Only select process instances which have a global variable value less than or equal to the passed value.
 ProcessInstanceQuery variableValueLike(String name, String value)
          Only select process instances which have a global variable value like the given value.
 ProcessInstanceQuery variableValueNotEquals(String name, Object value)
          Only select process instances which have a global variable with the given name, but with a different value than the passed value.
 ProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name, String value)
          Only select process instances which have a local string variable which is not the given value, case insensitive.
 
从接口 org.activiti.engine.query.Query 继承的方法
asc, count, desc, list, listPage, singleResult
 

方法详细信息

processInstanceId

ProcessInstanceQuery processInstanceId(String processInstanceId)
Select the process instance with the given id


processInstanceIds

ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
Select process instances whose id is in the given set of ids


processInstanceBusinessKey

ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey)
Select process instances with the given business key


processInstanceBusinessKey

ProcessInstanceQuery processInstanceBusinessKey(String processInstanceBusinessKey,
                                                String processDefinitionKey)
Select process instance with the given business key, unique for the given process definition


processDefinitionName

ProcessInstanceQuery processDefinitionName(String processDefinitionName)
Select process instances whose process definition name is processDefinitionName


processDefinitionKey

ProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
Select the process instances which are defined by a process definition with the given key.


processDefinitionId

ProcessInstanceQuery processDefinitionId(String processDefinitionId)
Select the process instances which are defined by a process definition with the given id.


superProcessInstanceId

ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
Select the process instances which are a sub process instance of the given super process instance.


subProcessInstanceId

ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
Select the process instance that have as sub process instance the given process instance. Note that there will always be maximum only one such process instance that can be the result of this query.


excludeSubprocesses

ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
Exclude sub processes from the query result;


involvedUser

ProcessInstanceQuery involvedUser(String userId)
Select the process instances with which the user with the given id is involved.


variableValueEquals

ProcessInstanceQuery variableValueEquals(String name,
                                         Object value)
Only select process instances which have a global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

参数:
name - name of the variable, cannot be null.

variableValueEquals

ProcessInstanceQuery variableValueEquals(Object value)
Only select process instances which have at least one global variable with the given value. The type of variable is determined based on the value, using types configured in ProcessEngineConfiguration#getVariableTypes(). Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.


variableValueEqualsIgnoreCase

ProcessInstanceQuery variableValueEqualsIgnoreCase(String name,
                                                   String value)
Only select process instances which have a local string variable with the given value, case insensitive.

This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).

参数:
name - name of the variable, cannot be null.
value - value of the variable, cannot be null.

variableValueNotEquals

ProcessInstanceQuery variableValueNotEquals(String name,
                                            Object value)
Only select process 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.

参数:
name - name of the variable, cannot be null.

variableValueNotEqualsIgnoreCase

ProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name,
                                                      String value)
Only select process instances which have a local string variable which is not the given value, case insensitive.

This method only works if your database has encoding/collation that supports case-sensitive queries. For example, use "collate UTF-8" on MySQL and for MSSQL, select one of the case-sensitive Collations available (MSDN Server Collation Reference).

参数:
name - name of the variable, cannot be null.
value - value of the variable, cannot be null.

variableValueGreaterThan

ProcessInstanceQuery variableValueGreaterThan(String name,
                                              Object value)
Only select process instances 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.

参数:
name - variable name, cannot be null.
value - variable value, cannot be null.

variableValueGreaterThanOrEqual

ProcessInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                     Object value)
Only select process 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.

参数:
name - variable name, cannot be null.
value - variable value, cannot be null.

variableValueLessThan

ProcessInstanceQuery variableValueLessThan(String name,
                                           Object value)
Only select process 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.

参数:
name - variable name, cannot be null.
value - variable value, cannot be null.

variableValueLessThanOrEqual

ProcessInstanceQuery variableValueLessThanOrEqual(String name,
                                                  Object value)
Only select process 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.

参数:
name - variable name, cannot be null.
value - variable value, cannot be null.

variableValueLike

ProcessInstanceQuery variableValueLike(String name,
                                       String value)
Only select process instances which have a global variable value like the given value. This be used on string variables only.

参数:
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%).

suspended

ProcessInstanceQuery suspended()
Only select process instances which are suspended, either because the process instance itself is suspended or because the corresponding process definition is suspended


active

ProcessInstanceQuery active()
Only select process instances which are active, which means that neither the process instance nor the corresponding process definition are suspended.


includeProcessVariables

ProcessInstanceQuery includeProcessVariables()
Include process variables in the process query result


orderByProcessInstanceId

ProcessInstanceQuery orderByProcessInstanceId()
Order by id (needs to be followed by Query.asc() or Query.desc()).


orderByProcessDefinitionKey

ProcessInstanceQuery orderByProcessDefinitionKey()
Order by process definition key (needs to be followed by Query.asc() or Query.desc()).


orderByProcessDefinitionId

ProcessInstanceQuery orderByProcessDefinitionId()
Order by process definition id (needs to be followed by Query.asc() or Query.desc()).



Copyright © 2013 Alfresco. All rights reserved.