Package org.flowable.common.engine.impl.query

Class AbstractQuery<T extends Query<?,?>,U>

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<T,U>

All Implemented Interfaces:

Serializable, Query<T,U>, Command<Object>

Direct Known Subclasses:

AbstractVariableQueryImpl, ActivityInstanceQueryImpl, BatchPartQueryImpl, BatchQueryImpl, CaseDefinitionQueryImpl, ChannelDefinitionQueryImpl, CmmnDeploymentQueryImpl, DeadLetterJobQueryImpl, DecisionQueryImpl, DeploymentQueryImpl, DmnDeploymentQueryImpl, EventDefinitionQueryImpl, EventDeploymentQueryImpl, EventSubscriptionQueryImpl, ExternalWorkerJobQueryImpl, GroupQueryImpl, HistoricActivityInstanceQueryImpl, HistoricDecisionExecutionQueryImpl, HistoricDetailQueryImpl, HistoricMilestoneInstanceQueryImpl, HistoricPlanItemInstanceQueryImpl, HistoricTaskLogEntryQueryImpl, HistoricVariableInstanceQueryImpl, HistoryJobQueryImpl, JobQueryImpl, MilestoneInstanceQueryImpl, ModelQueryImpl, PrivilegeQueryImpl, ProcessDefinitionQueryImpl, SuspendedJobQueryImpl, TimerJobQueryImpl, TokenQueryImpl, UserQueryImpl, VariableInstanceQueryImpl

public abstract class AbstractQuery<T extends Query<?,?>,U>
extends ListQueryParameterObject
implements Command<Object>, Query<T,U>, Serializable

Abstract superclass for all query types.

Author:

Joram Barrez

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

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

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandContext	commandContext
protected CommandExecutor	commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractQuery()
	AbstractQuery(CommandContext commandContext)
protected	AbstractQuery(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
T	asc()	Order the results ascending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).
protected void	checkQueryOk()
long	count()	Executes the query and returns the number of results
T	desc()	Order the results descending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).
T	direction(Direction direction)
Object	execute(CommandContext commandContext)
abstract long	executeCount(CommandContext commandContext)
abstract List<U>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
U	executeSingleResult(CommandContext commandContext)
List<U>	list()	Executes the query and get a list of entities as the result.
List<U>	listPage(int firstResult, int maxResults)	Executes the query and get a list of entities as the result.
T	orderBy(QueryProperty property)
T	orderBy(QueryProperty property, Query.NullHandlingOnOrder nullHandlingOnOrder)
AbstractQuery<T,U>	setCommandExecutor(CommandExecutor commandExecutor)
U	singleResult()	Executes the query and returns the resulting entity or null if no entity matches the query criteria.

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

commandExecutor

protected transient CommandExecutor commandExecutor

commandContext

protected transient CommandContext commandContext

Constructor Details

AbstractQuery

protected AbstractQuery()

AbstractQuery

protected AbstractQuery(CommandExecutor commandExecutor)

AbstractQuery

public AbstractQuery(CommandContext commandContext)

Method Details

setCommandExecutor

public AbstractQuery<T,U> setCommandExecutor(CommandExecutor commandExecutor)

orderBy

public T orderBy(QueryProperty property)

Specified by:

orderBy in interface Query<T extends Query<?,?>,U>

orderBy

public T orderBy(QueryProperty property,
 Query.NullHandlingOnOrder nullHandlingOnOrder)

Specified by:

orderBy in interface Query<T extends Query<?,?>,U>

asc

public T asc()

Description copied from interface: Query

Order the results ascending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).

Specified by:

asc in interface Query<T extends Query<?,?>,U>

desc

public T desc()

Description copied from interface: Query

Order the results descending on the given property as defined in this class (needs to come after a call to one of the orderByXxxx methods).

Specified by:

desc in interface Query<T extends Query<?,?>,U>

direction

public T direction(Direction direction)

checkQueryOk

protected void checkQueryOk()

singleResult

public U singleResult()

Description copied from interface: Query

Executes the query and returns the resulting entity or null if no entity matches the query criteria.

Specified by:

singleResult in interface Query<T extends Query<?,?>,U>

list

public List<U> list()

Description copied from interface: Query

Executes the query and get a list of entities as the result.

Specified by:

list in interface Query<T extends Query<?,?>,U>

listPage

public List<U> listPage(int firstResult,
 int maxResults)

Description copied from interface: Query

Executes the query and get a list of entities as the result.

Specified by:

listPage in interface Query<T extends Query<?,?>,U>

count

public long count()

Description copied from interface: Query

Executes the query and returns the number of results

Specified by:

count in interface Query<T extends Query<?,?>,U>

execute

public Object execute(CommandContext commandContext)

Specified by:

execute in interface Command<T extends Query<?,?>>

executeCount

public abstract long executeCount(CommandContext commandContext)

executeList

public abstract List<U> executeList(CommandContext commandContext)

Executes the actual query to retrieve the list of results.

executeSingleResult

public U executeSingleResult(CommandContext commandContext)