Package org.flowable.engine.impl.cmd

Class AbstractSetProcessDefinitionStateCmd

java.lang.Object

org.flowable.engine.impl.cmd.AbstractSetProcessDefinitionStateCmd

All Implemented Interfaces:

Command<Void>

Direct Known Subclasses:

ActivateProcessDefinitionCmd, SuspendProcessDefinitionCmd

public abstract class AbstractSetProcessDefinitionStateCmd
extends Object
implements Command<Void>

Author:

Daniel Meyer, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	executionDate
protected boolean	includeProcessInstances
protected ProcessDefinitionEntity	processDefinitionEntity
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
AbstractSetProcessDefinitionStateCmd(String processDefinitionId, String processDefinitionKey, boolean includeProcessInstances, Date executionDate, String tenantId)
AbstractSetProcessDefinitionStateCmd(ProcessDefinitionEntity processDefinitionEntity, boolean includeProcessInstances, Date executionDate, String tenantId)

Method Summary

Modifier and Type	Method	Description
protected void	changeProcessDefinitionState(CommandContext commandContext, List<ProcessDefinitionEntity> processDefinitions)
protected void	createTimerForDelayedExecution(CommandContext commandContext, List<ProcessDefinitionEntity> processDefinitions)
Void	execute(CommandContext commandContext)
protected List<ProcessInstance>	fetchProcessInstancesPage(CommandContext commandContext, ProcessDefinition processDefinition, int currentPageStartIndex)
protected List<ProcessDefinitionEntity>	findProcessDefinition(CommandContext commandContext)
protected abstract String	getDelayedExecutionJobHandlerType()	Subclasses should return the type of the JobHandler here.
protected abstract SuspensionState	getProcessDefinitionSuspensionState()	Subclasses should return the wanted SuspensionState here.
protected abstract AbstractSetProcessInstanceStateCmd	getProcessInstanceChangeStateCmd(ProcessInstance processInstance)	Subclasses should return a Command implementation that matches the process definition state change.

Methods inherited from class java.lang.Object

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

Field Details

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

processDefinitionEntity

protected ProcessDefinitionEntity processDefinitionEntity

includeProcessInstances

protected boolean includeProcessInstances

executionDate

protected Date executionDate

tenantId

protected String tenantId

Constructor Details

AbstractSetProcessDefinitionStateCmd

public AbstractSetProcessDefinitionStateCmd(ProcessDefinitionEntity processDefinitionEntity,
 boolean includeProcessInstances,
 Date executionDate,
 String tenantId)

AbstractSetProcessDefinitionStateCmd

public AbstractSetProcessDefinitionStateCmd(String processDefinitionId,
 String processDefinitionKey,
 boolean includeProcessInstances,
 Date executionDate,
 String tenantId)

Method Details

execute

public Void execute(CommandContext commandContext)

Specified by:

execute in interface Command<Void>

findProcessDefinition

protected List<ProcessDefinitionEntity> findProcessDefinition(CommandContext commandContext)

createTimerForDelayedExecution

protected void createTimerForDelayedExecution(CommandContext commandContext,
 List<ProcessDefinitionEntity> processDefinitions)

changeProcessDefinitionState

protected void changeProcessDefinitionState(CommandContext commandContext,
 List<ProcessDefinitionEntity> processDefinitions)

fetchProcessInstancesPage

protected List<ProcessInstance> fetchProcessInstancesPage(CommandContext commandContext,
 ProcessDefinition processDefinition,
 int currentPageStartIndex)

getProcessDefinitionSuspensionState

protected abstract SuspensionState getProcessDefinitionSuspensionState()

Subclasses should return the wanted SuspensionState here.

getDelayedExecutionJobHandlerType

protected abstract String getDelayedExecutionJobHandlerType()

Subclasses should return the type of the JobHandler here. it will be used when the user provides an execution date on which the actual state change will happen.

getProcessInstanceChangeStateCmd

protected abstract AbstractSetProcessInstanceStateCmd getProcessInstanceChangeStateCmd(ProcessInstance processInstance)

Subclasses should return a Command implementation that matches the process definition state change.