Package org.flowable.job.service.impl.persistence.entity

Interface TimerJobEntityManager

All Superinterfaces:

EntityManager<TimerJobEntity>, JobInfoEntityManager<TimerJobEntity>

All Known Implementing Classes:

TimerJobEntityManagerImpl

public interface TimerJobEntityManager
extends JobInfoEntityManager<TimerJobEntity>

EntityManager responsible for TimerJobEntity instances.

Author:

Tijs Rademakers, Vasile Dirla

Method Summary

Modifier and Type	Method	Description
void	bulkDeleteTimerJobsWithoutRevisionCheck(List<TimerJobEntity> timerJobEntities)
TimerJobEntity	createAndCalculateNextTimer(JobEntity timerEntity, org.flowable.variable.api.delegate.VariableScope variableScope)	Creates a new TimerJobEntity, typically when a timer is used in a repeating way.
TimerJobEntity	findJobByCorrelationId(String correlationId)	Find the timer job with the given correlation id.
long	findJobCountByQueryCriteria(TimerJobQueryImpl jobQuery)	Same as findJobsByQueryCriteria(TimerJobQueryImpl), but only returns a count and not the instances itself.
List<Job>	findJobsByQueryCriteria(TimerJobQueryImpl jobQuery)	Executes a JobQueryImpl and returns the matching TimerJobEntity instances.
List<TimerJobEntity>	findJobsByScopeIdAndSubScopeId(String scopeId, String subScopeId)	Returns all TimerJobEntity for the given scope and subscope.
List<TimerJobEntity>	findJobsByTypeAndProcessDefinitionId(String type, String processDefinitionId)	Returns the TimerJobEntity for a given process definition.
List<TimerJobEntity>	findJobsByTypeAndProcessDefinitionKeyAndTenantId(String type, String processDefinitionKey, String tenantId)	The same as findJobsByTypeAndProcessDefinitionId(String, String), but by key and for a specific tenantId.
List<TimerJobEntity>	findJobsByTypeAndProcessDefinitionKeyNoTenantId(String type, String processDefinitionKey)	The same as findJobsByTypeAndProcessDefinitionId(String, String), but by key and specifically for the 'no tenant' mode.
boolean	insertTimerJobEntity(TimerJobEntity timerJobEntity)	Insert the TimerJobEntity, similar to insert(TimerJobEntity), but returns a boolean in case the insert did not go through.

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.EntityManager

create, delete, delete, delete, findById, insert, insert, update, update

Methods inherited from interface org.flowable.job.service.impl.persistence.entity.JobInfoEntityManager

bulkUpdateJobLockWithoutRevisionCheck, findExpiredJobs, findJobsByExecutionId, findJobsByProcessInstanceId, findJobsToExecute, findJobsToExecuteAndLockInBulk, resetExpiredJob, updateJobTenantIdForDeployment

Method Detail

insertTimerJobEntity

boolean insertTimerJobEntity(TimerJobEntity timerJobEntity)

Insert the TimerJobEntity, similar to insert(TimerJobEntity), but returns a boolean in case the insert did not go through. This could happen if the execution related to the TimerJobEntity has been removed (for example due to a task complete for a timer boundary on that task).

findJobByCorrelationId

TimerJobEntity findJobByCorrelationId(String correlationId)

Find the timer job with the given correlation id.

findJobsByTypeAndProcessDefinitionId

List<TimerJobEntity> findJobsByTypeAndProcessDefinitionId(String type,
                                                          String processDefinitionId)

Returns the TimerJobEntity for a given process definition.

This is for example used when deleting a process definition: it finds the TimerJobEntity representing the timer start events.

findJobsByTypeAndProcessDefinitionKeyAndTenantId

List<TimerJobEntity> findJobsByTypeAndProcessDefinitionKeyAndTenantId(String type,
                                                                      String processDefinitionKey,
                                                                      String tenantId)

The same as findJobsByTypeAndProcessDefinitionId(String, String), but by key and for a specific tenantId.

findJobsByTypeAndProcessDefinitionKeyNoTenantId

List<TimerJobEntity> findJobsByTypeAndProcessDefinitionKeyNoTenantId(String type,
                                                                     String processDefinitionKey)

The same as findJobsByTypeAndProcessDefinitionId(String, String), but by key and specifically for the 'no tenant' mode.

findJobsByScopeIdAndSubScopeId

List<TimerJobEntity> findJobsByScopeIdAndSubScopeId(String scopeId,
                                                    String subScopeId)

Returns all TimerJobEntity for the given scope and subscope.

findJobsByQueryCriteria

List<Job> findJobsByQueryCriteria(TimerJobQueryImpl jobQuery)

Executes a JobQueryImpl and returns the matching TimerJobEntity instances.

findJobCountByQueryCriteria

long findJobCountByQueryCriteria(TimerJobQueryImpl jobQuery)

Same as findJobsByQueryCriteria(TimerJobQueryImpl), but only returns a count and not the instances itself.

createAndCalculateNextTimer

TimerJobEntity createAndCalculateNextTimer(JobEntity timerEntity,
                                           org.flowable.variable.api.delegate.VariableScope variableScope)

Creates a new TimerJobEntity, typically when a timer is used in a repeating way. The returns TimerJobEntity is not yet inserted.

Returns null if the timer has finished its repetitions.

bulkDeleteTimerJobsWithoutRevisionCheck

void bulkDeleteTimerJobsWithoutRevisionCheck(List<TimerJobEntity> timerJobEntities)