org.flowable.engine.impl.persistence.entity

Interface TimerJobEntityManager

All Superinterfaces:

EntityManager<TimerJobEntity>

All Known Implementing Classes:

TimerJobEntityManagerImpl

public interface TimerJobEntityManager
extends EntityManager<TimerJobEntity>

EntityManager responsible for TimerJobEntity instances.

Author:

Tijs Rademakers, Vasile Dirla

Method Summary

Modifier and Type	Method and Description
TimerJobEntity	createAndCalculateNextTimer(JobEntity timerEntity, VariableScope variableScope) Creates a new TimerJobEntity, typically when a timer is used in a repeating way.
long	findJobCountByQueryCriteria(TimerJobQueryImpl jobQuery) Same as findJobsByQueryCriteria(TimerJobQueryImpl, Page), but only returns a count and not the instances itself.
List<TimerJobEntity>	findJobsByExecutionId(String id) Returns all TimerJobEntity instances related to on ExecutionEntity.
List<TimerJobEntity>	findJobsByProcessInstanceId(String id) Returns all TimerJobEntity instances related to on ExecutionEntity.
List<Job>	findJobsByQueryCriteria(TimerJobQueryImpl jobQuery, Page page) Executes a JobQueryImpl and returns the matching TimerJobEntity instances.
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.
List<TimerJobEntity>	findTimerJobsToExecute(Page page) Returns the TimerJobEntity instances that are eligible to execute, meaning the due date of the timer has been passed.
boolean	insertTimerJobEntity(TimerJobEntity timerJobEntity) Insert the TimerJobEntity, similar to #insert(TimerJobEntity), but returns a boolean in case the insert did not go through.
void	updateJobTenantIdForDeployment(String deploymentId, String newTenantId) Changes the tenantId for all jobs related to a given DeploymentEntity.

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

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

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).

findTimerJobsToExecute

List<TimerJobEntity> findTimerJobsToExecute(Page page)

Returns the TimerJobEntity instances that are eligible to execute, meaning the due date of the timer has been passed.

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.

findJobsByExecutionId

List<TimerJobEntity> findJobsByExecutionId(String id)

Returns all TimerJobEntity instances related to on ExecutionEntity.

findJobsByProcessInstanceId

List<TimerJobEntity> findJobsByProcessInstanceId(String id)

Returns all TimerJobEntity instances related to on ExecutionEntity.

findJobsByQueryCriteria

List<Job> findJobsByQueryCriteria(TimerJobQueryImpl jobQuery,
                                  Page page)

Executes a JobQueryImpl and returns the matching TimerJobEntity instances.

findJobCountByQueryCriteria

long findJobCountByQueryCriteria(TimerJobQueryImpl jobQuery)

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

createAndCalculateNextTimer

TimerJobEntity createAndCalculateNextTimer(JobEntity timerEntity,
                                           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.

updateJobTenantIdForDeployment

void updateJobTenantIdForDeployment(String deploymentId,
                                    String newTenantId)

Changes the tenantId for all jobs related to a given DeploymentEntity.