public class ProcessInstanceQueryImpl extends AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance> implements ProcessInstanceQuery, Serializable
AbstractQuery.NullHandlingOnOrderqueryVariableValuescommandContext, commandExecutor, databaseType, nullHandlingOnOrder, orderBy, orderProperty, resultType, SORTORDER_ASC, SORTORDER_DESCfirstResult, maxResults, parameter| Constructor and Description |
|---|
ProcessInstanceQueryImpl() |
ProcessInstanceQueryImpl(CommandContext commandContext) |
ProcessInstanceQueryImpl(CommandExecutor commandExecutor) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstanceQuery |
active()
Only select process instances which are active, which means that
neither the process instance nor the corresponding process definition
are suspended.
|
ProcessInstanceQueryImpl |
deploymentId(String deploymentId)
Select the process instances which are defined by a deployment
with the given id.
|
ProcessInstanceQueryImpl |
deploymentIdIn(List<String> deploymentIds)
Select the process instances which are defined by one of the given deployment ids
|
ProcessInstanceQuery |
endOr()
End an OR statement.
|
protected void |
ensureVariablesInitialized() |
ProcessInstanceQuery |
excludeSubprocesses(boolean excludeSubprocesses)
Exclude sub processes from the query result;
|
long |
executeCount(CommandContext commandContext) |
List<ProcessInstance> |
executeList(CommandContext commandContext,
Page page)
Executes the actual query to retrieve the list of results.
|
String |
getActivityId() |
String |
getBusinessKey() |
String |
getDeploymentId() |
List<String> |
getDeploymentIds() |
List<EventSubscriptionQueryValue> |
getEventSubscriptions() |
String |
getExecutionId() |
String |
getInvolvedUser() |
String |
getMssqlOrDB2OrderBy() |
String |
getName() |
String |
getNameLike() |
String |
getNameLikeIgnoreCase() |
boolean |
getOnlyProcessInstances() |
List<ProcessInstanceQueryImpl> |
getOrQueryObjects() |
String |
getParentId()
Method needed for ibatis because of re-use of query-xml for executions.
|
String |
getProcessDefinitionCategory() |
String |
getProcessDefinitionId() |
Set<String> |
getProcessDefinitionIds() |
String |
getProcessDefinitionKey() |
Set<String> |
getProcessDefinitionKeys() |
String |
getProcessDefinitionName() |
Integer |
getProcessDefinitionVersion() |
String |
getProcessInstanceId() |
Set<String> |
getProcessInstanceIds() |
String |
getSubProcessInstanceId() |
String |
getSuperProcessInstanceId() |
SuspensionState |
getSuspensionState() |
String |
getTenantId() |
String |
getTenantIdLike() |
ProcessInstanceQuery |
includeProcessVariables()
Include process variables in the process query result
|
ProcessInstanceQuery |
involvedUser(String involvedUser)
Select the process instances with which the user with the given id is involved.
|
boolean |
isExcludeSubprocesses() |
boolean |
isIncludeChildExecutionsWithBusinessKeyQuery() |
boolean |
isIncludeProcessVariables() |
boolean |
iswithException() |
boolean |
isWithoutTenantId() |
ProcessInstanceQuery |
locale(String locale)
Localize process name and description to specified locale.
|
protected void |
localize(ProcessInstance processInstance) |
ProcessInstanceQuery |
or()
Begin an OR statement.
|
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 |
orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc()). |
ProcessInstanceQuery |
processDefinitionCategory(String processDefinitionCategory)
Only select process instances whose process definition category is processDefinitionCategory.
|
ProcessInstanceQueryImpl |
processDefinitionId(String processDefinitionId)
Select the process instances which are defined by a process definition
with the given id.
|
ProcessInstanceQuery |
processDefinitionIds(Set<String> processDefinitionIds)
Select the process instances which are defined by process definitions
with the given ids.
|
ProcessInstanceQueryImpl |
processDefinitionKey(String processDefinitionKey)
Select the process instances which are defined by a process definition with
the given key.
|
ProcessInstanceQuery |
processDefinitionKeys(Set<String> processDefinitionKeys)
Select the process instances which are defined by process definitions with
the given keys.
|
ProcessInstanceQuery |
processDefinitionName(String processDefinitionName)
Select process instances whose process definition name is processDefinitionName
|
ProcessInstanceQuery |
processDefinitionVersion(Integer processDefinitionVersion)
Only select process instances with a certain process definition version.
|
ProcessInstanceQuery |
processInstanceBusinessKey(String businessKey)
Select process instances with the given business key
|
ProcessInstanceQuery |
processInstanceBusinessKey(String businessKey,
String processDefinitionKey)
Select process instance with the given business key, unique for the given process definition
|
ProcessInstanceQueryImpl |
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 |
processInstanceName(String name)
Only select process instances with the given name.
|
ProcessInstanceQuery |
processInstanceNameLike(String nameLike)
Only select process instances with a name like the given value.
|
ProcessInstanceQuery |
processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
Only select process instances with a name like the given value, ignoring upper/lower case.
|
ProcessInstanceQuery |
processInstanceTenantId(String tenantId)
Only select process instances that have the given tenant id.
|
ProcessInstanceQuery |
processInstanceTenantIdLike(String tenantIdLike)
Only select process instances with a tenant id like the given one.
|
ProcessInstanceQuery |
processInstanceWithoutTenantId()
Only select process instances that do not have a tenant id.
|
void |
setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions) |
void |
setName(String name) |
void |
setNameLike(String nameLike) |
void |
setSuspensionState(SuspensionState suspensionState) |
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 variableValue)
Only select process instances which have at least one global variable with the given value.
|
ProcessInstanceQuery |
variableValueEquals(String variableName,
Object variableValue)
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 |
variableValueLikeIgnoreCase(String name,
String value)
Only select process instances which have a global variable value like the given value (case insensitive).
|
ProcessInstanceQuery |
variableValueNotEquals(String variableName,
Object variableValue)
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.
|
ProcessInstanceQuery |
withJobException()
Only select process instances that failed due to an exception happening during a job execution.
|
ProcessInstanceQuery |
withLocalizationFallback()
Instruct localization to fallback to more general locales including the default locale of the JVM if the specified locale is not found.
|
addVariable, getQueryVariableValues, isBoolean, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueLikeIgnoreCase, variableValueNotEquals, variableValueNotEqualsIgnoreCaseaddOrder, asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, getDatabaseType, getOrderBy, getOrderByColumns, list, listPage, orderBy, orderBy, setCommandExecutor, setDatabaseType, singleResultgetFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, setFirstResult, setMaxResults, setParameterprotected String executionId
protected String businessKey
protected boolean includeChildExecutionsWithBusinessKeyQuery
protected String processDefinitionId
protected String processDefinitionCategory
protected String processDefinitionName
protected Integer processDefinitionVersion
protected String processDefinitionKey
protected String deploymentId
protected String superProcessInstanceId
protected String subProcessInstanceId
protected boolean excludeSubprocesses
protected String involvedUser
protected SuspensionState suspensionState
protected boolean includeProcessVariables
protected boolean withJobException
protected String name
protected String nameLike
protected String nameLikeIgnoreCase
protected String locale
protected boolean withLocalizationFallback
protected String tenantId
protected String tenantIdLike
protected boolean withoutTenantId
protected List<ProcessInstanceQueryImpl> orQueryObjects
protected ProcessInstanceQueryImpl currentOrQueryObject
protected boolean inOrStatement
protected String activityId
protected List<EventSubscriptionQueryValue> eventSubscriptions
public ProcessInstanceQueryImpl()
public ProcessInstanceQueryImpl(CommandContext commandContext)
public ProcessInstanceQueryImpl(CommandExecutor commandExecutor)
public ProcessInstanceQueryImpl processInstanceId(String processInstanceId)
ProcessInstanceQueryprocessInstanceId in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
ProcessInstanceQueryprocessInstanceIds in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceBusinessKey(String businessKey)
ProcessInstanceQueryprocessInstanceBusinessKey in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceBusinessKey(String businessKey, String processDefinitionKey)
ProcessInstanceQueryprocessInstanceBusinessKey in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceTenantId(String tenantId)
ProcessInstanceQueryprocessInstanceTenantId in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceTenantIdLike(String tenantIdLike)
ProcessInstanceQueryprocessInstanceTenantIdLike in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceWithoutTenantId()
ProcessInstanceQueryprocessInstanceWithoutTenantId in interface ProcessInstanceQuerypublic ProcessInstanceQuery processDefinitionCategory(String processDefinitionCategory)
ProcessInstanceQueryprocessDefinitionCategory in interface ProcessInstanceQuerypublic ProcessInstanceQuery processDefinitionName(String processDefinitionName)
ProcessInstanceQueryprocessDefinitionName in interface ProcessInstanceQuerypublic ProcessInstanceQuery processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceQueryProcessInstanceQuery.processDefinitionKey(String)processDefinitionVersion in interface ProcessInstanceQuerypublic ProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
ProcessInstanceQueryprocessDefinitionId in interface ProcessInstanceQuerypublic ProcessInstanceQuery processDefinitionIds(Set<String> processDefinitionIds)
ProcessInstanceQueryprocessDefinitionIds in interface ProcessInstanceQuerypublic ProcessInstanceQueryImpl processDefinitionKey(String processDefinitionKey)
ProcessInstanceQueryprocessDefinitionKey in interface ProcessInstanceQuerypublic ProcessInstanceQuery processDefinitionKeys(Set<String> processDefinitionKeys)
ProcessInstanceQueryprocessDefinitionKeys in interface ProcessInstanceQuerypublic ProcessInstanceQueryImpl deploymentId(String deploymentId)
ProcessInstanceQuerydeploymentId in interface ProcessInstanceQuerypublic ProcessInstanceQueryImpl deploymentIdIn(List<String> deploymentIds)
ProcessInstanceQuerydeploymentIdIn in interface ProcessInstanceQuerypublic ProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
ProcessInstanceQuerysuperProcessInstanceId in interface ProcessInstanceQuerypublic ProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
ProcessInstanceQuerysubProcessInstanceId in interface ProcessInstanceQuerypublic ProcessInstanceQuery excludeSubprocesses(boolean excludeSubprocesses)
ProcessInstanceQueryexcludeSubprocesses in interface ProcessInstanceQuerypublic ProcessInstanceQuery involvedUser(String involvedUser)
ProcessInstanceQueryinvolvedUser in interface ProcessInstanceQuerypublic ProcessInstanceQuery active()
ProcessInstanceQueryactive in interface ProcessInstanceQuerypublic ProcessInstanceQuery suspended()
ProcessInstanceQuerysuspended in interface ProcessInstanceQuerypublic ProcessInstanceQuery includeProcessVariables()
ProcessInstanceQueryincludeProcessVariables in interface ProcessInstanceQuerypublic ProcessInstanceQuery withJobException()
ProcessInstanceQuerywithJobException in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceName(String name)
ProcessInstanceQueryprocessInstanceName in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceNameLike(String nameLike)
ProcessInstanceQueryprocessInstanceNameLike in interface ProcessInstanceQuerypublic ProcessInstanceQuery processInstanceNameLikeIgnoreCase(String nameLikeIgnoreCase)
ProcessInstanceQueryprocessInstanceNameLikeIgnoreCase in interface ProcessInstanceQuerypublic ProcessInstanceQuery or()
ProcessInstanceQueryor in interface ProcessInstanceQuerypublic ProcessInstanceQuery endOr()
ProcessInstanceQueryendOr in interface ProcessInstanceQuerypublic ProcessInstanceQuery variableValueEquals(String variableName, Object variableValue)
ProcessInstanceQueryProcessEngineConfiguration#getVariableTypes().
Byte-arrays and Serializable objects (which are not primitive type wrappers)
are not supported.variableValueEquals in interface ProcessInstanceQueryvariableValueEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>variableName - name of the variable, cannot be null.public ProcessInstanceQuery variableValueNotEquals(String variableName, Object variableValue)
ProcessInstanceQuerySerializable objects (which are not primitive type wrappers)
are not supported.variableValueNotEquals in interface ProcessInstanceQueryvariableValueNotEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>variableName - name of the variable, cannot be null.public ProcessInstanceQuery variableValueEquals(Object variableValue)
ProcessInstanceQueryProcessEngineConfiguration#getVariableTypes().
Byte-arrays and Serializable objects (which are not primitive type wrappers)
are not supported.variableValueEquals in interface ProcessInstanceQueryvariableValueEquals in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>public ProcessInstanceQuery variableValueEqualsIgnoreCase(String name, String value)
ProcessInstanceQueryThis 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).
variableValueEqualsIgnoreCase in interface ProcessInstanceQueryvariableValueEqualsIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - name of the variable, cannot be null.value - value of the variable, cannot be null.public ProcessInstanceQuery variableValueNotEqualsIgnoreCase(String name, String value)
ProcessInstanceQueryThis 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).
variableValueNotEqualsIgnoreCase in interface ProcessInstanceQueryvariableValueNotEqualsIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - name of the variable, cannot be null.value - value of the variable, cannot be null.public ProcessInstanceQuery variableValueGreaterThan(String name, Object value)
ProcessInstanceQuerySerializable objects (which are not primitive type wrappers)
are not supported.variableValueGreaterThan in interface ProcessInstanceQueryvariableValueGreaterThan in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - variable name, cannot be null.value - variable value, cannot be null.public ProcessInstanceQuery variableValueGreaterThanOrEqual(String name, Object value)
ProcessInstanceQuerySerializable objects (which
are not primitive type wrappers) are not supported.variableValueGreaterThanOrEqual in interface ProcessInstanceQueryvariableValueGreaterThanOrEqual in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - variable name, cannot be null.value - variable value, cannot be null.public ProcessInstanceQuery variableValueLessThan(String name, Object value)
ProcessInstanceQuerySerializable objects (which are not primitive type wrappers)
are not supported.variableValueLessThan in interface ProcessInstanceQueryvariableValueLessThan in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - variable name, cannot be null.value - variable value, cannot be null.public ProcessInstanceQuery variableValueLessThanOrEqual(String name, Object value)
ProcessInstanceQuerySerializable objects (which are not primitive type wrappers)
are not supported.variableValueLessThanOrEqual in interface ProcessInstanceQueryvariableValueLessThanOrEqual in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>name - variable name, cannot be null.value - variable value, cannot be null.public ProcessInstanceQuery variableValueLike(String name, String value)
ProcessInstanceQueryvariableValueLike in interface ProcessInstanceQueryvariableValueLike in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>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%).public ProcessInstanceQuery variableValueLikeIgnoreCase(String name, String value)
ProcessInstanceQueryvariableValueLikeIgnoreCase in interface ProcessInstanceQueryvariableValueLikeIgnoreCase in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>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%).public ProcessInstanceQuery locale(String locale)
ProcessInstanceQuerylocale in interface ProcessInstanceQuerypublic ProcessInstanceQuery withLocalizationFallback()
ProcessInstanceQuerywithLocalizationFallback in interface ProcessInstanceQuerypublic ProcessInstanceQuery orderByProcessInstanceId()
ProcessInstanceQueryQuery.asc() or Query.desc()).orderByProcessInstanceId in interface ProcessInstanceQuerypublic ProcessInstanceQuery orderByProcessDefinitionId()
ProcessInstanceQueryQuery.asc() or Query.desc()).orderByProcessDefinitionId in interface ProcessInstanceQuerypublic ProcessInstanceQuery orderByProcessDefinitionKey()
ProcessInstanceQueryQuery.asc() or Query.desc()).orderByProcessDefinitionKey in interface ProcessInstanceQuerypublic ProcessInstanceQuery orderByTenantId()
ProcessInstanceQueryQuery.asc() or Query.desc()).orderByTenantId in interface ProcessInstanceQuerypublic String getMssqlOrDB2OrderBy()
public long executeCount(CommandContext commandContext)
executeCount in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>public List<ProcessInstance> executeList(CommandContext commandContext, Page page)
AbstractQueryexecuteList in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>page - used if the results must be paged. If null, no paging will be applied.protected void ensureVariablesInitialized()
ensureVariablesInitialized in class AbstractVariableQueryImpl<ProcessInstanceQuery,ProcessInstance>protected void localize(ProcessInstance processInstance)
public boolean getOnlyProcessInstances()
public String getProcessInstanceId()
public String getBusinessKey()
public boolean isIncludeChildExecutionsWithBusinessKeyQuery()
public String getProcessDefinitionId()
public String getProcessDefinitionCategory()
public String getProcessDefinitionName()
public Integer getProcessDefinitionVersion()
public String getProcessDefinitionKey()
public String getActivityId()
public String getSuperProcessInstanceId()
public String getSubProcessInstanceId()
public boolean isExcludeSubprocesses()
public String getInvolvedUser()
public SuspensionState getSuspensionState()
public void setSuspensionState(SuspensionState suspensionState)
public List<EventSubscriptionQueryValue> getEventSubscriptions()
public void setEventSubscriptions(List<EventSubscriptionQueryValue> eventSubscriptions)
public String getTenantId()
public String getTenantIdLike()
public boolean isWithoutTenantId()
public String getName()
public String getNameLike()
public void setName(String name)
public void setNameLike(String nameLike)
public String getExecutionId()
public String getDeploymentId()
public boolean isIncludeProcessVariables()
public boolean iswithException()
public String getNameLikeIgnoreCase()
public List<ProcessInstanceQueryImpl> getOrQueryObjects()
public String getParentId()
Copyright © 2016 Alfresco. All rights reserved.