Class BatchQueryImpl

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<BatchQuery, Batch>

org.flowable.batch.service.impl.BatchQueryImpl

All Implemented Interfaces:

Serializable, BatchQuery, CacheAwareQuery<BatchEntity>, DeleteQuery<BatchQuery, Batch>, Query<BatchQuery, Batch>, Command<Object>

public class BatchQueryImpl
extends AbstractQuery<BatchQuery, Batch>
implements BatchQuery, CacheAwareQuery<BatchEntity>, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected BatchServiceConfiguration	batchServiceConfiguration
protected String	batchType
protected Collection<String>	batchTypes
protected Date	completeTimeHigherThan
protected Date	completeTimeLowerThan
protected Date	createTimeHigherThan
protected Date	createTimeLowerThan
protected String	id
protected String	searchKey
protected String	searchKey2
protected String	status
protected String	tenantId
protected String	tenantIdLike
protected boolean	withoutTenantId

Fields inherited from class AbstractQuery

commandContext, commandExecutor

Fields inherited from class ListQueryParameterObject

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

Constructor Summary

Constructors

Constructor	Description
BatchQueryImpl()
BatchQueryImpl(CommandContext commandContext, BatchServiceConfiguration batchServiceConfiguration)
BatchQueryImpl(CommandExecutor commandExecutor, BatchServiceConfiguration batchServiceConfiguration)

Method Summary

Modifier and Type	Method	Description
BatchQuery	batchId(String batchId)	Only select batches with the given id
BatchQuery	batchType(String batchType)	Only select batches which exist for the given type.
BatchQuery	batchTypes(Collection<String> batchTypes)	Only select batches which exist for the given types.
BatchQuery	completeTimeHigherThan(Date date)	Only select batches where the complete time is higher then the given date.
BatchQuery	completeTimeLowerThan(Date date)	Only select batches where the complete time is lower than the given date.
BatchQuery	createTimeHigherThan(Date date)	Only select batches where the create time is higher then the given date.
BatchQuery	createTimeLowerThan(Date date)	Only select batches where the create time is lower than the given date.
void	delete()	Delete all instances that match the query.
void	deleteWithRelatedData()	Deprecated.
long	executeCount(CommandContext commandContext)
protected void	executeDelete(CommandContext commandContext)
List<Batch>	executeList(CommandContext commandContext)	Executes the actual query to retrieve the list of results.
String	getBatchType()
Collection<String>	getBatchTypes()
Date	getCreateTimeHigherThan()
Date	getCreateTimeLowerThan()
String	getId()
String	getSearchKey()
String	getSearchKey2()
String	getStatus()
String	getTenantId()
String	getTenantIdLike()
boolean	isWithoutTenantId()
BatchQuery	orderByBatchCreateTime()	Order by batch create time (needs to be followed by Query.asc() or Query.desc()).
BatchQuery	orderByBatchId()	Order by batch id (needs to be followed by Query.asc() or Query.desc()).
BatchQuery	orderByBatchTenantId()	Order by batch create time (needs to be followed by Query.asc() or Query.desc()).
BatchQuery	searchKey(String searchKey)	Only select batches which exist for the given search key.
BatchQuery	searchKey2(String searchKey)	Only select batches which exist for the given search key.
BatchQuery	status(String status)	Only select batches which exist for the given status.
BatchQuery	tenantId(String tenantId)	Only select batches which exist for the given tenant id.
BatchQuery	tenantIdLike(String tenantIdLike)	Only select batches with a tenant id like the given one.
BatchQuery	withoutTenantId()	Only select batches that do not have a tenant id.

Methods inherited from class AbstractQuery

asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, getSafeList, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class ListQueryParameterObject

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

Methods inherited from class Object

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

Methods inherited from interface CacheAwareQuery

enhanceCachedValue

Methods inherited from interface Query

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

Field Details

batchServiceConfiguration

protected BatchServiceConfiguration batchServiceConfiguration

id

protected String id

batchType

protected String batchType

batchTypes

protected Collection<String> batchTypes

searchKey

protected String searchKey

searchKey2

protected String searchKey2

createTimeHigherThan

protected Date createTimeHigherThan

createTimeLowerThan

protected Date createTimeLowerThan

completeTimeHigherThan

protected Date completeTimeHigherThan

completeTimeLowerThan

protected Date completeTimeLowerThan

status

protected String status

tenantId

protected String tenantId

tenantIdLike

protected String tenantIdLike

withoutTenantId

protected boolean withoutTenantId

Constructor Details

BatchQueryImpl

public BatchQueryImpl()

BatchQueryImpl

public BatchQueryImpl(CommandContext commandContext,
 BatchServiceConfiguration batchServiceConfiguration)

BatchQueryImpl

public BatchQueryImpl(CommandExecutor commandExecutor,
 BatchServiceConfiguration batchServiceConfiguration)

Method Details

batchId

public BatchQuery batchId(String batchId)

Description copied from interface: BatchQuery

Only select batches with the given id

Specified by:

batchId in interface BatchQuery

batchType

public BatchQuery batchType(String batchType)

Description copied from interface: BatchQuery

Only select batches which exist for the given type.

Specified by:

batchType in interface BatchQuery

batchTypes

public BatchQuery batchTypes(Collection<String> batchTypes)

Description copied from interface: BatchQuery

Only select batches which exist for the given types.

Specified by:

batchTypes in interface BatchQuery

searchKey

public BatchQuery searchKey(String searchKey)

Description copied from interface: BatchQuery

Only select batches which exist for the given search key.

Specified by:

searchKey in interface BatchQuery

searchKey2

public BatchQuery searchKey2(String searchKey)

Description copied from interface: BatchQuery

Only select batches which exist for the given search key.

Specified by:

searchKey2 in interface BatchQuery

createTimeHigherThan

public BatchQuery createTimeHigherThan(Date date)

Description copied from interface: BatchQuery

Only select batches where the create time is higher then the given date.

Specified by:

createTimeHigherThan in interface BatchQuery

createTimeLowerThan

public BatchQuery createTimeLowerThan(Date date)

Description copied from interface: BatchQuery

Only select batches where the create time is lower than the given date.

Specified by:

createTimeLowerThan in interface BatchQuery

completeTimeHigherThan

public BatchQuery completeTimeHigherThan(Date date)

Description copied from interface: BatchQuery

Only select batches where the complete time is higher then the given date.

Specified by:

completeTimeHigherThan in interface BatchQuery

completeTimeLowerThan

public BatchQuery completeTimeLowerThan(Date date)

Description copied from interface: BatchQuery

Only select batches where the complete time is lower than the given date.

Specified by:

completeTimeLowerThan in interface BatchQuery

status

public BatchQuery status(String status)

Description copied from interface: BatchQuery

Only select batches which exist for the given status.

Specified by:

status in interface BatchQuery

tenantId

public BatchQuery tenantId(String tenantId)

Description copied from interface: BatchQuery

Only select batches which exist for the given tenant id.

Specified by:

tenantId in interface BatchQuery

tenantIdLike

public BatchQuery tenantIdLike(String tenantIdLike)

Description copied from interface: BatchQuery

Only select batches with a tenant id like the given one.

Specified by:

tenantIdLike in interface BatchQuery

withoutTenantId

public BatchQuery withoutTenantId()

Description copied from interface: BatchQuery

Only select batches that do not have a tenant id.

Specified by:

withoutTenantId in interface BatchQuery

orderByBatchCreateTime

public BatchQuery orderByBatchCreateTime()

Description copied from interface: BatchQuery

Order by batch create time (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByBatchCreateTime in interface BatchQuery

orderByBatchId

public BatchQuery orderByBatchId()

Description copied from interface: BatchQuery

Order by batch id (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByBatchId in interface BatchQuery

orderByBatchTenantId

public BatchQuery orderByBatchTenantId()

Description copied from interface: BatchQuery

Order by batch create time (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByBatchTenantId in interface BatchQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<BatchQuery, Batch>

executeList

public List<Batch> executeList(CommandContext commandContext)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<BatchQuery, Batch>

delete

public void delete()

Description copied from interface: DeleteQuery

Delete all instances that match the query.

Specified by:

delete in interface DeleteQuery<BatchQuery, Batch>

executeDelete

protected void executeDelete(CommandContext commandContext)

deleteWithRelatedData

@Deprecated
public void deleteWithRelatedData()

Deprecated.

Description copied from interface: DeleteQuery

Delete all instances and their related data that match the query in bulk. Note that only the historical data directly related to the instance will be deleted. This means that for example for historic case/process instances, it will not delete any associated historic case/process instance (these should be deleted through the respective deletion for the particular model) which is owned by another engine (e.g. a process for the cmmn engine). Use the specific deletion methods on the respective history services otherwise: they delete with cascading to all other engines, but are not as performant as the bulk delete here.

Specified by:

deleteWithRelatedData in interface DeleteQuery<BatchQuery, Batch>

getId

public String getId()

Specified by:

getId in interface CacheAwareQuery<BatchEntity>

getBatchType

public String getBatchType()

getBatchTypes

public Collection<String> getBatchTypes()

getSearchKey

public String getSearchKey()

getSearchKey2

public String getSearchKey2()

getCreateTimeHigherThan

public Date getCreateTimeHigherThan()

getCreateTimeLowerThan

public Date getCreateTimeLowerThan()

getStatus

public String getStatus()

getTenantId

public String getTenantId()

getTenantIdLike

public String getTenantIdLike()

isWithoutTenantId

public boolean isWithoutTenantId()