org.flowable.cmmn.api.runtime

Interface PlanItemInstanceQuery

All Superinterfaces:

Query<PlanItemInstanceQuery,PlanItemInstance>

public interface PlanItemInstanceQuery
extends Query<PlanItemInstanceQuery,PlanItemInstance>

Author:

Joram Barrez, Tijs Rademakers

Nested Class Summary

Nested classes/interfaces inherited from interface org.flowable.engine.common.api.query.Query

Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method and Description
PlanItemInstanceQuery	caseDefinitionId(String caseDefinitionId)
PlanItemInstanceQuery	caseInstanceId(String caseInstanceId)
PlanItemInstanceQuery	caseVariableExists(String name) Only select plan item instances which have a global variable with the given name.
PlanItemInstanceQuery	caseVariableNotExists(String name) Only select plan item instances which don't have a global variable with the given name.
PlanItemInstanceQuery	caseVariableValueEquals(Object value) Only select plan item instances which have at least one global variable with the given value.
PlanItemInstanceQuery	caseVariableValueEquals(String name, Object value) Only select plan item instances which have a global variable with the given value.
PlanItemInstanceQuery	caseVariableValueEqualsIgnoreCase(String name, String value) Only select plan item instances which have a global string variable with the given value, case insensitive.
PlanItemInstanceQuery	caseVariableValueGreaterThan(String name, Object value) Only select plan item instances which have a global variable value greater than the passed value.
PlanItemInstanceQuery	caseVariableValueGreaterThanOrEqual(String name, Object value) Only select plan item instances which have a global variable value greater than or equal to the passed value.
PlanItemInstanceQuery	caseVariableValueLessThan(String name, Object value) Only select plan item instances which have a global variable value less than the passed value.
PlanItemInstanceQuery	caseVariableValueLessThanOrEqual(String name, Object value) Only select plan item instances which have a global variable value less than or equal to the passed value.
PlanItemInstanceQuery	caseVariableValueLike(String name, String value) Only select plan item instances which have a global variable value like the given value.
PlanItemInstanceQuery	caseVariableValueLikeIgnoreCase(String name, String value) Only select plan item instances which have a global variable value like the given value (case insensitive).
PlanItemInstanceQuery	caseVariableValueNotEquals(String name, Object value) Only select plan item instances which have a global variable with the given name, but with a different value than the passed value.
PlanItemInstanceQuery	caseVariableValueNotEqualsIgnoreCase(String name, String value) Only select plan item instances which have a global string variable which is not the given value, case insensitive.
PlanItemInstanceQuery	orderByName()
PlanItemInstanceQuery	orderByStartTime()
PlanItemInstanceQuery	planItemCompleteable()
PlanItemInstanceQuery	planItemDefinitionId(String planItemDefinitionId)
PlanItemInstanceQuery	planItemDefinitionType(String planItemDefinitionType)
PlanItemInstanceQuery	planItemInstanceElementId(String elementId)
PlanItemInstanceQuery	planItemInstanceId(String planItemInstanceId)
PlanItemInstanceQuery	planItemInstanceName(String name)
PlanItemInstanceQuery	planItemInstanceReferenceId(String referenceId)
PlanItemInstanceQuery	planItemInstanceReferenceType(String referenceType)
PlanItemInstanceQuery	planItemInstanceStartedAfter(Date startedAfer)
PlanItemInstanceQuery	planItemInstanceStartedBefore(Date startedBefore)
PlanItemInstanceQuery	planItemInstanceStartUserId(String startUserId)
PlanItemInstanceQuery	planItemInstanceState(String state)
PlanItemInstanceQuery	planItemInstanceStateActive()
PlanItemInstanceQuery	planItemInstanceStateAsyncActive()
PlanItemInstanceQuery	planItemInstanceStateAvailable()
PlanItemInstanceQuery	planItemInstanceStateCompleted()
PlanItemInstanceQuery	planItemInstanceStateDisabled()
PlanItemInstanceQuery	planItemInstanceStateEnabled()
PlanItemInstanceQuery	planItemInstanceStateTerminated()
PlanItemInstanceQuery	planItemInstanceStateWaitingForRepetition()
PlanItemInstanceQuery	planItemInstanceTenantId(String tenantId)
PlanItemInstanceQuery	planItemInstanceWithoutTenantId()
PlanItemInstanceQuery	stageInstanceId(String stageInstanceId)
PlanItemInstanceQuery	variableExists(String name) Only select plan item instances which have a local variable with the given name.
PlanItemInstanceQuery	variableNotExists(String name) Only select plan item instances which don't have a local variable with the given name.
PlanItemInstanceQuery	variableValueEquals(Object value) Only select plan item instances which have at least one local variable with the given value.
PlanItemInstanceQuery	variableValueEquals(String name, Object value) Only select plan item instances which have a local variable with the given value.
PlanItemInstanceQuery	variableValueEqualsIgnoreCase(String name, String value) Only select plan item instances which have a local string variable with the given value, case insensitive.
PlanItemInstanceQuery	variableValueGreaterThan(String name, Object value) Only select plan item instances which have a local variable value greater than the passed value.
PlanItemInstanceQuery	variableValueGreaterThanOrEqual(String name, Object value) Only select plan item instances which have a local variable value greater than or equal to the passed value.
PlanItemInstanceQuery	variableValueLessThan(String name, Object value) Only select plan item instances which have a local variable value less than the passed value.
PlanItemInstanceQuery	variableValueLessThanOrEqual(String name, Object value) Only select plan item instances which have a local variable value less than or equal to the passed value.
PlanItemInstanceQuery	variableValueLike(String name, String value) Only select plan item instances which have a local variable value like the given value.
PlanItemInstanceQuery	variableValueLikeIgnoreCase(String name, String value) Only select plan item instances which have a local variable value like the given value (case insensitive).
PlanItemInstanceQuery	variableValueNotEquals(String name, Object value) Only select plan item instances which have a local variable with the given name, but with a different value than the passed value.
PlanItemInstanceQuery	variableValueNotEqualsIgnoreCase(String name, String value) Only select plan item instances which have a local string variable which is not the given value, case insensitive.

Methods inherited from interface org.flowable.engine.common.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Method Detail

caseDefinitionId

PlanItemInstanceQuery caseDefinitionId(String caseDefinitionId)

caseInstanceId

PlanItemInstanceQuery caseInstanceId(String caseInstanceId)

stageInstanceId

PlanItemInstanceQuery stageInstanceId(String stageInstanceId)

planItemInstanceId

PlanItemInstanceQuery planItemInstanceId(String planItemInstanceId)

planItemInstanceElementId

PlanItemInstanceQuery planItemInstanceElementId(String elementId)

planItemInstanceName

PlanItemInstanceQuery planItemInstanceName(String name)

planItemInstanceState

PlanItemInstanceQuery planItemInstanceState(String state)

planItemInstanceStateWaitingForRepetition

PlanItemInstanceQuery planItemInstanceStateWaitingForRepetition()

planItemInstanceStateEnabled

PlanItemInstanceQuery planItemInstanceStateEnabled()

planItemInstanceStateDisabled

PlanItemInstanceQuery planItemInstanceStateDisabled()

planItemInstanceStateActive

PlanItemInstanceQuery planItemInstanceStateActive()

planItemInstanceStateAsyncActive

PlanItemInstanceQuery planItemInstanceStateAsyncActive()

planItemInstanceStateAvailable

PlanItemInstanceQuery planItemInstanceStateAvailable()

planItemInstanceStateCompleted

PlanItemInstanceQuery planItemInstanceStateCompleted()

planItemInstanceStateTerminated

PlanItemInstanceQuery planItemInstanceStateTerminated()

planItemInstanceStartedBefore

PlanItemInstanceQuery planItemInstanceStartedBefore(Date startedBefore)

planItemInstanceStartedAfter

PlanItemInstanceQuery planItemInstanceStartedAfter(Date startedAfer)

planItemInstanceStartUserId

PlanItemInstanceQuery planItemInstanceStartUserId(String startUserId)

planItemInstanceReferenceId

PlanItemInstanceQuery planItemInstanceReferenceId(String referenceId)

planItemInstanceReferenceType

PlanItemInstanceQuery planItemInstanceReferenceType(String referenceType)

planItemCompleteable

PlanItemInstanceQuery planItemCompleteable()

planItemInstanceTenantId

PlanItemInstanceQuery planItemInstanceTenantId(String tenantId)

planItemInstanceWithoutTenantId

PlanItemInstanceQuery planItemInstanceWithoutTenantId()

planItemDefinitionId

PlanItemInstanceQuery planItemDefinitionId(String planItemDefinitionId)

planItemDefinitionType

PlanItemInstanceQuery planItemDefinitionType(String planItemDefinitionType)

variableValueEquals

PlanItemInstanceQuery variableValueEquals(String name,
                                          Object value)

Only select plan item instances which have a local variable with the given value. The type of variable is determined based on the value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - name of the variable, cannot be null.

variableValueEquals

PlanItemInstanceQuery variableValueEquals(Object value)

Only select plan item instances which have at least one local variable with the given value. The type of variable is determined based on the value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

variableValueEqualsIgnoreCase

PlanItemInstanceQuery variableValueEqualsIgnoreCase(String name,
                                                    String value)

Only select plan item 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).

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

variableValueNotEquals

PlanItemInstanceQuery variableValueNotEquals(String name,
                                             Object value)

Only select plan item instances which have a local 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.

variableValueNotEqualsIgnoreCase

PlanItemInstanceQuery variableValueNotEqualsIgnoreCase(String name,
                                                       String value)

Only select plan item 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).

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

variableValueGreaterThan

PlanItemInstanceQuery variableValueGreaterThan(String name,
                                               Object value)

Only select plan item instances which have a local 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.

variableValueGreaterThanOrEqual

PlanItemInstanceQuery variableValueGreaterThanOrEqual(String name,
                                                      Object value)

Only select plan item instances which have a local 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.

variableValueLessThan

PlanItemInstanceQuery variableValueLessThan(String name,
                                            Object value)

Only select plan item instances which have a local 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.

variableValueLessThanOrEqual

PlanItemInstanceQuery variableValueLessThanOrEqual(String name,
                                                   Object value)

Only select plan item instances which have a local 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.

variableValueLike

PlanItemInstanceQuery variableValueLike(String name,
                                        String value)

Only select plan item instances which have a local variable value 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%).

variableValueLikeIgnoreCase

PlanItemInstanceQuery variableValueLikeIgnoreCase(String name,
                                                  String value)

Only select plan item instances which have a local variable value like the given value (case insensitive). 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%).

variableExists

PlanItemInstanceQuery variableExists(String name)

Only select plan item instances which have a local variable with the given name.

Parameters:

name - cannot be null.

variableNotExists

PlanItemInstanceQuery variableNotExists(String name)

Only select plan item instances which don't have a local variable with the given name.

Parameters:

name - cannot be null.

caseVariableValueEquals

PlanItemInstanceQuery caseVariableValueEquals(String name,
                                              Object value)

Only select plan item instances which have a global variable with the given value. The type of variable is determined based on the value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

Parameters:

name - name of the variable, cannot be null.

caseVariableValueEquals

PlanItemInstanceQuery caseVariableValueEquals(Object value)

Only select plan item instances which have at least one global variable with the given value. The type of variable is determined based on the value. Byte-arrays and Serializable objects (which are not primitive type wrappers) are not supported.

caseVariableValueEqualsIgnoreCase

PlanItemInstanceQuery caseVariableValueEqualsIgnoreCase(String name,
                                                        String value)

Only select plan item instances which have a global 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).

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

caseVariableValueNotEquals

PlanItemInstanceQuery caseVariableValueNotEquals(String name,
                                                 Object value)

Only select plan item 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.

caseVariableValueNotEqualsIgnoreCase

PlanItemInstanceQuery caseVariableValueNotEqualsIgnoreCase(String name,
                                                           String value)

Only select plan item instances which have a global 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).

Parameters:

name - name of the variable, cannot be null.

value - value of the variable, cannot be null.

caseVariableValueGreaterThan

PlanItemInstanceQuery caseVariableValueGreaterThan(String name,
                                                   Object value)

Only select plan item 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.

caseVariableValueGreaterThanOrEqual

PlanItemInstanceQuery caseVariableValueGreaterThanOrEqual(String name,
                                                          Object value)

Only select plan item 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.

caseVariableValueLessThan

PlanItemInstanceQuery caseVariableValueLessThan(String name,
                                                Object value)

Only select plan item 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.

caseVariableValueLessThanOrEqual

PlanItemInstanceQuery caseVariableValueLessThanOrEqual(String name,
                                                       Object value)

Only select plan item 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.

caseVariableValueLike

PlanItemInstanceQuery caseVariableValueLike(String name,
                                            String value)

Only select plan item instances which have a global variable value 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%).

caseVariableValueLikeIgnoreCase

PlanItemInstanceQuery caseVariableValueLikeIgnoreCase(String name,
                                                      String value)

Only select plan item instances which have a global variable value like the given value (case insensitive). 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%).

caseVariableExists

PlanItemInstanceQuery caseVariableExists(String name)

Only select plan item instances which have a global variable with the given name.

Parameters:

name - cannot be null.

caseVariableNotExists

PlanItemInstanceQuery caseVariableNotExists(String name)

Only select plan item instances which don't have a global variable with the given name.

Parameters:

name - cannot be null.

orderByStartTime

PlanItemInstanceQuery orderByStartTime()

orderByName

PlanItemInstanceQuery orderByName()