Package org.camunda.bpm.engine.impl.batch.history

Class HistoricBatchQueryImpl

java.lang.Object

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

org.camunda.bpm.engine.impl.AbstractQuery<HistoricBatchQuery,HistoricBatch>

org.camunda.bpm.engine.impl.batch.history.HistoricBatchQueryImpl

All Implemented Interfaces:

Serializable, HistoricBatchQuery, Command<Object>, Query<HistoricBatchQuery,HistoricBatch>

public class HistoricBatchQueryImpl
extends AbstractQuery<HistoricBatchQuery,HistoricBatch>
implements HistoricBatchQuery

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	Description
protected String	batchId
protected Boolean	completed
protected boolean	isTenantIdSet
protected String[]	tenantIds
protected String	type

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

commandExecutor, expressions, maxResultsLimitEnabled, 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	Description
HistoricBatchQueryImpl(CommandExecutor commandExecutor)

Method Summary

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

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

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, 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, unlimitedList

Field Details

batchId

protected String batchId

type

protected String type

completed

protected Boolean completed

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

Constructor Details

HistoricBatchQueryImpl

public HistoricBatchQueryImpl(CommandExecutor commandExecutor)

Method Details

batchId

public HistoricBatchQuery batchId(String batchId)

Description copied from interface: HistoricBatchQuery

Only select historic batch instances for the given batch id.

Specified by:

batchId in interface HistoricBatchQuery

getBatchId

public String getBatchId()

type

public HistoricBatchQuery type(String type)

Description copied from interface: HistoricBatchQuery

Only select historic batches of the given type.

Specified by:

type in interface HistoricBatchQuery

completed

public HistoricBatchQuery completed(boolean completed)

Description copied from interface: HistoricBatchQuery

Only select historic batches which are completed or not.

Specified by:

completed in interface HistoricBatchQuery

tenantIdIn

public HistoricBatchQuery tenantIdIn(String... tenantIds)

Description copied from interface: HistoricBatchQuery

Only selects historic batches with one of the given tenant ids.

Specified by:

tenantIdIn in interface HistoricBatchQuery

getTenantIds

public String[] getTenantIds()

isTenantIdSet

public boolean isTenantIdSet()

withoutTenantId

public HistoricBatchQuery withoutTenantId()

Description copied from interface: HistoricBatchQuery

Only selects historic batches which have no tenant id.

Specified by:

withoutTenantId in interface HistoricBatchQuery

getType

public String getType()

orderById

public HistoricBatchQuery orderById()

Description copied from interface: HistoricBatchQuery

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

Specified by:

orderById in interface HistoricBatchQuery

orderByStartTime

public HistoricBatchQuery orderByStartTime()

Description copied from interface: HistoricBatchQuery

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

Specified by:

orderByStartTime in interface HistoricBatchQuery

orderByEndTime

public HistoricBatchQuery orderByEndTime()

Description copied from interface: HistoricBatchQuery

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

Specified by:

orderByEndTime in interface HistoricBatchQuery

orderByTenantId

public HistoricBatchQuery orderByTenantId()

Description copied from interface: HistoricBatchQuery

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

Specified by:

orderByTenantId in interface HistoricBatchQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<HistoricBatchQuery,HistoricBatch>

executeList

public List<HistoricBatch> 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<HistoricBatchQuery,HistoricBatch>

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