org.camunda.bpm.engine.impl.batch

Class BatchQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<BatchQuery,Batch>

org.camunda.bpm.engine.impl.batch.BatchQueryImpl

All Implemented Interfaces:

Serializable, BatchQuery, Command<Object>, Query<BatchQuery,Batch>

public class BatchQueryImpl
extends AbstractQuery<BatchQuery,Batch>
implements BatchQuery

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	batchId
protected boolean	isTenantIdSet
protected SuspensionState	suspensionState
protected String[]	tenantIds
protected String	type

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor and Description
BatchQueryImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
BatchQuery	active() Only selects batches which are active
BatchQuery	batchId(String batchId) Only select batch instances for the given batch id.
long	executeCount(CommandContext commandContext)
List<Batch>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
String	getBatchId()
SuspensionState	getSuspensionState()
String[]	getTenantIds()
String	getType()
boolean	isTenantIdSet()
BatchQuery	orderById() Returns batches sorted by id; must be followed by an invocation of Query.asc() or Query.desc().
BatchQuery	orderByTenantId() Returns batches sorted by tenant id; must be followed by an invocation of Query.asc() or Query.desc().
BatchQuery	suspended() Only selects batches which are suspended
BatchQuery	tenantIdIn(String... tenantIds) Only selects batches with one of the given tenant ids.
BatchQuery	type(String type) Only select batches of the given type.
BatchQuery	withoutTenantId() Only selects batches which have no tenant id.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkQueryOk, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeIdsList, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Field Detail

batchId

protected String batchId

type

protected String type

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

suspensionState

protected SuspensionState suspensionState

Constructor Detail

BatchQueryImpl

public BatchQueryImpl(CommandExecutor commandExecutor)

Method Detail

batchId

public BatchQuery batchId(String batchId)

Description copied from interface: BatchQuery

Only select batch instances for the given batch id.

Specified by:

batchId in interface BatchQuery

getBatchId

public String getBatchId()

type

public BatchQuery type(String type)

Description copied from interface: BatchQuery

Only select batches of the given type.

Specified by:

type in interface BatchQuery

getType

public String getType()

tenantIdIn

public BatchQuery tenantIdIn(String... tenantIds)

Description copied from interface: BatchQuery

Only selects batches with one of the given tenant ids.

Specified by:

tenantIdIn in interface BatchQuery

getTenantIds

public String[] getTenantIds()

isTenantIdSet

public boolean isTenantIdSet()

withoutTenantId

public BatchQuery withoutTenantId()

Description copied from interface: BatchQuery

Only selects batches which have no tenant id.

Specified by:

withoutTenantId in interface BatchQuery

active

public BatchQuery active()

Description copied from interface: BatchQuery

Only selects batches which are active

Specified by:

active in interface BatchQuery

suspended

public BatchQuery suspended()

Description copied from interface: BatchQuery

Only selects batches which are suspended

Specified by:

suspended in interface BatchQuery

getSuspensionState

public SuspensionState getSuspensionState()

orderById

public BatchQuery orderById()

Description copied from interface: BatchQuery

Returns batches sorted by id; must be followed by an invocation of Query.asc() or Query.desc().

Specified by:

orderById in interface BatchQuery

orderByTenantId

public BatchQuery orderByTenantId()

Description copied from interface: BatchQuery

Returns batches sorted by tenant id; must be followed by an invocation of Query.asc() or Query.desc().

Specified by:

orderByTenantId in interface BatchQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<BatchQuery,Batch>

executeList

public List<Batch> executeList(CommandContext commandContext,
                      Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<BatchQuery,Batch>

page - used if the results must be paged. If null, no paging will be applied.