Package org.flowable.engine.impl.cmd

Class SuspendProcessDefinitionCmd

java.lang.Object

org.flowable.engine.impl.cmd.AbstractSetProcessDefinitionStateCmd

org.flowable.engine.impl.cmd.SuspendProcessDefinitionCmd

All Implemented Interfaces:

Command<Void>

public class SuspendProcessDefinitionCmd
extends AbstractSetProcessDefinitionStateCmd

Author:

Daniel Meyer, Joram Barrez

Field Summary

Fields inherited from class org.flowable.engine.impl.cmd.AbstractSetProcessDefinitionStateCmd

executionDate, includeProcessInstances, processDefinitionEntity, processDefinitionId, processDefinitionKey, tenantId

Constructor Summary

Constructors

Constructor	Description
SuspendProcessDefinitionCmd(String processDefinitionId, String processDefinitionKey, boolean suspendProcessInstances, Date suspensionDate, String tenantId)
SuspendProcessDefinitionCmd(ProcessDefinitionEntity processDefinitionEntity, boolean includeProcessInstances, Date executionDate, String tenantId)

Method Summary

Modifier and Type	Method	Description
protected String	getDelayedExecutionJobHandlerType()	Subclasses should return the type of the JobHandler here.
protected SuspensionState	getProcessDefinitionSuspensionState()	Subclasses should return the wanted SuspensionState here.
protected AbstractSetProcessInstanceStateCmd	getProcessInstanceChangeStateCmd(ProcessInstance processInstance)	Subclasses should return a Command implementation that matches the process definition state change.

Methods inherited from class org.flowable.engine.impl.cmd.AbstractSetProcessDefinitionStateCmd

changeProcessDefinitionState, createTimerForDelayedExecution, execute, fetchProcessInstancesPage, findProcessDefinition

Methods inherited from class java.lang.Object

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

Constructor Details

SuspendProcessDefinitionCmd

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

SuspendProcessDefinitionCmd

public SuspendProcessDefinitionCmd(String processDefinitionId,
 String processDefinitionKey,
 boolean suspendProcessInstances,
 Date suspensionDate,
 String tenantId)

Method Details

getProcessDefinitionSuspensionState

protected SuspensionState getProcessDefinitionSuspensionState()

Description copied from class: AbstractSetProcessDefinitionStateCmd

Subclasses should return the wanted SuspensionState here.

Specified by:

getProcessDefinitionSuspensionState in class AbstractSetProcessDefinitionStateCmd

getDelayedExecutionJobHandlerType

protected String getDelayedExecutionJobHandlerType()

Description copied from class: AbstractSetProcessDefinitionStateCmd

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.

Specified by:

getDelayedExecutionJobHandlerType in class AbstractSetProcessDefinitionStateCmd

getProcessInstanceChangeStateCmd

protected AbstractSetProcessInstanceStateCmd getProcessInstanceChangeStateCmd(ProcessInstance processInstance)

Description copied from class: AbstractSetProcessDefinitionStateCmd

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

Specified by:

getProcessInstanceChangeStateCmd in class AbstractSetProcessDefinitionStateCmd