org.flowable.engine.impl.persistence.entity

Interface JobEntityManager

All Superinterfaces:

EntityManager<JobEntity>

All Known Implementing Classes:

JobEntityManagerImpl

public interface JobEntityManager
extends EntityManager<JobEntity>

EntityManager responsible for the JobEntity class.

Author:

Joram Barrez

Method Summary

Modifier and Type	Method and Description
List<JobEntity>	findExpiredJobs(Page page) Returns all JobEntity instance which are expired, which means that the lock time of the JobEntity is past a certain configurable date and is deemed to be in error.
long	findJobCountByQueryCriteria(JobQueryImpl jobQuery) Same as findJobsByQueryCriteria(JobQueryImpl, Page), but only returns a count and not the instances itself.
List<JobEntity>	findJobsByExecutionId(String executionId) Returns all JobEntity instances related to on ExecutionEntity.
List<JobEntity>	findJobsByProcessInstanceId(String processInstanceId) Returns all JobEntity instances related to one process instance ExecutionEntity.
List<Job>	findJobsByQueryCriteria(JobQueryImpl jobQuery, Page page) Executes a JobQueryImpl and returns the matching JobEntity instances.
List<JobEntity>	findJobsToExecute(Page page) Returns JobEntity that are eligible to be executed.
boolean	insertJobEntity(JobEntity timerJobEntity) Insert the JobEntity, similar to #insert(JobEntity), but returns a boolean in case the insert did not go through.
void	resetExpiredJob(String jobId) Resets an expired job.
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

insertJobEntity

boolean insertJobEntity(JobEntity timerJobEntity)

Insert the JobEntity, similar to #insert(JobEntity), but returns a boolean in case the insert did not go through. This could happen if the execution related to the JobEntity has been removed.

findJobsToExecute

List<JobEntity> findJobsToExecute(Page page)

Returns JobEntity that are eligible to be executed. For example used by the default AcquireJobsCmd command used by the default AcquireTimerJobsRunnable implementation to get async jobs that can be executed.

findJobsByExecutionId

List<JobEntity> findJobsByExecutionId(String executionId)

Returns all JobEntity instances related to on ExecutionEntity.

findJobsByProcessInstanceId

List<JobEntity> findJobsByProcessInstanceId(String processInstanceId)

Returns all JobEntity instances related to one process instance ExecutionEntity.

findExpiredJobs

List<JobEntity> findExpiredJobs(Page page)

Returns all JobEntity instance which are expired, which means that the lock time of the JobEntity is past a certain configurable date and is deemed to be in error.

findJobsByQueryCriteria

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

Executes a JobQueryImpl and returns the matching JobEntity instances.

findJobCountByQueryCriteria

long findJobCountByQueryCriteria(JobQueryImpl jobQuery)

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

resetExpiredJob

void resetExpiredJob(String jobId)

Resets an expired job. These are jobs that were locked, but not completed. Resetting these will make them available for being picked up by other executors.

updateJobTenantIdForDeployment

void updateJobTenantIdForDeployment(String deploymentId,
                                    String newTenantId)

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