Package org.camunda.bpm.engine.impl.cmd

Class AbstractSetStateCmd

java.lang.Object

org.camunda.bpm.engine.impl.cmd.AbstractSetStateCmd

All Implemented Interfaces:

Command<Void>

Direct Known Subclasses:

AbstractSetJobDefinitionStateCmd, AbstractSetJobStateCmd, AbstractSetProcessDefinitionStateCmd, AbstractSetProcessInstanceStateCmd

public abstract class AbstractSetStateCmd
extends Object
implements Command<Void>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	executionDate
protected boolean	includeSubResources
protected boolean	isLogUserOperationDisabled
protected static final String	SUSPENSION_STATE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractSetStateCmd(boolean includeSubResources, Date executionDate)

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkAuthorization(CommandContext commandContext)
protected abstract void	checkParameters(CommandContext commandContext)
void	disableLogUserOperation()
Void	execute(CommandContext commandContext)
protected String	getDelayedExecutionJobHandlerType()
protected String	getDeploymentId(CommandContext commandContext)
protected String	getDeploymentIdByJobDefinition(CommandContext commandContext, String jobDefinitionId)
protected String	getDeploymentIdByProcessDefinition(CommandContext commandContext, String processDefinitionId)
protected String	getDeploymentIdByProcessDefinitionKey(CommandContext commandContext, String processDefinitionKey, boolean tenantIdSet, String tenantId)
protected JobHandlerConfiguration	getJobHandlerConfiguration()
protected abstract String	getLogEntryOperation()
protected abstract SuspensionState	getNewSuspensionState()
protected AbstractSetStateCmd	getNextCommand()
protected boolean	isIncludeSubResources()
protected boolean	isLogUserOperationDisabled()
protected abstract void	logUserOperation(CommandContext commandContext)
protected void	scheduleSuspensionStateUpdate(CommandContext commandContext)
protected void	triggerHistoryEvent(CommandContext commandContext)
protected abstract void	updateSuspensionState(CommandContext commandContext, SuspensionState suspensionState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

isRetryable

Field Details

SUSPENSION_STATE_PROPERTY

protected static final String SUSPENSION_STATE_PROPERTY

See Also:

• Constant Field Values

includeSubResources

protected boolean includeSubResources

isLogUserOperationDisabled

protected boolean isLogUserOperationDisabled

executionDate

protected Date executionDate

Constructor Details

AbstractSetStateCmd

public AbstractSetStateCmd(boolean includeSubResources,
 Date executionDate)

Method Details

execute

public Void execute(CommandContext commandContext)

Specified by:

execute in interface Command<Void>

triggerHistoryEvent

protected void triggerHistoryEvent(CommandContext commandContext)

disableLogUserOperation

public void disableLogUserOperation()

isLogUserOperationDisabled

protected boolean isLogUserOperationDisabled()

isIncludeSubResources

protected boolean isIncludeSubResources()

scheduleSuspensionStateUpdate

protected void scheduleSuspensionStateUpdate(CommandContext commandContext)

getDelayedExecutionJobHandlerType

protected String getDelayedExecutionJobHandlerType()

getJobHandlerConfiguration

protected JobHandlerConfiguration getJobHandlerConfiguration()

getNextCommand

protected AbstractSetStateCmd getNextCommand()

getDeploymentId

protected String getDeploymentId(CommandContext commandContext)

Returns:

the id of the associated deployment, only necessary if the command can potentially be executed in a scheduled way (i.e. if an executionDate can be set) so the job executor responsible for that deployment can execute the resulting job

checkAuthorization

protected abstract void checkAuthorization(CommandContext commandContext)

checkParameters

protected abstract void checkParameters(CommandContext commandContext)

updateSuspensionState

protected abstract void updateSuspensionState(CommandContext commandContext,
 SuspensionState suspensionState)

logUserOperation

protected abstract void logUserOperation(CommandContext commandContext)

getLogEntryOperation

protected abstract String getLogEntryOperation()

getNewSuspensionState

protected abstract SuspensionState getNewSuspensionState()

getDeploymentIdByProcessDefinition

protected String getDeploymentIdByProcessDefinition(CommandContext commandContext,
 String processDefinitionId)

getDeploymentIdByProcessDefinitionKey

protected String getDeploymentIdByProcessDefinitionKey(CommandContext commandContext,
 String processDefinitionKey,
 boolean tenantIdSet,
 String tenantId)

getDeploymentIdByJobDefinition

protected String getDeploymentIdByJobDefinition(CommandContext commandContext,
 String jobDefinitionId)