Package org.flowable.cmmn.engine.impl.cmd

Class CompleteTaskWithFormCmd

java.lang.Object

org.flowable.cmmn.engine.impl.cmd.NeedsActiveTaskCmd<Void>

org.flowable.cmmn.engine.impl.cmd.CompleteTaskWithFormCmd

All Implemented Interfaces:

Serializable, Command<Void>

public class CompleteTaskWithFormCmd
extends NeedsActiveTaskCmd<Void>

Author:

Tijs Rademakers, Joram Barrez

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	formDefinitionId
protected boolean	localScope
protected String	outcome
protected Map<String,Object>	transientVariables
protected Map<String,Object>	transientVariablesLocal
protected String	userId
protected Map<String,Object>	variables
protected Map<String,Object>	variablesLocal

Fields inherited from class org.flowable.cmmn.engine.impl.cmd.NeedsActiveTaskCmd

taskId

Constructor Summary

Constructors

Constructor	Description
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, String userId, Map<String,Object> variables)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, String userId, Map<String,Object> variables, boolean localScope)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, String userId, Map<String,Object> variables, Map<String,Object> transientVariables)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, String userId, Map<String,Object> variables, Map<String,Object> variablesLocal, Map<String,Object> transientVariables, Map<String,Object> transientVariablesLocal)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables, boolean localScope)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables, Map<String,Object> transientVariables)
CompleteTaskWithFormCmd(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables, Map<String,Object> variablesLocal, Map<String,Object> transientVariables, Map<String,Object> transientVariablesLocal)

Method Summary

Modifier and Type	Method	Description
protected void	completeTask(CommandContext commandContext, TaskEntity task, Map<String,Object> taskVariables)
protected Void	execute(CommandContext commandContext, TaskEntity task)	Subclasses must implement in this method their normal command logic.
protected String	getSuspendedTaskExceptionPrefix()	Subclasses can override this method to provide a customized exception message that will be thrown when the task is suspended.
protected boolean	isFormFieldValidationEnabled(TaskEntity task)

Methods inherited from class org.flowable.cmmn.engine.impl.cmd.NeedsActiveTaskCmd

execute

Methods inherited from class java.lang.Object

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

Field Details

formDefinitionId

protected String formDefinitionId

outcome

protected String outcome

userId

protected String userId

variables

protected Map<String,Object> variables

variablesLocal

protected Map<String,Object> variablesLocal

transientVariables

protected Map<String,Object> transientVariables

transientVariablesLocal

protected Map<String,Object> transientVariablesLocal

localScope

protected boolean localScope

Constructor Details

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 Map<String,Object> variables)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 String userId,
 Map<String,Object> variables)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 Map<String,Object> variables,
 boolean localScope)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 String userId,
 Map<String,Object> variables,
 boolean localScope)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 Map<String,Object> variables,
 Map<String,Object> transientVariables)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 String userId,
 Map<String,Object> variables,
 Map<String,Object> transientVariables)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 Map<String,Object> variables,
 Map<String,Object> variablesLocal,
 Map<String,Object> transientVariables,
 Map<String,Object> transientVariablesLocal)

CompleteTaskWithFormCmd

public CompleteTaskWithFormCmd(String taskId,
 String formDefinitionId,
 String outcome,
 String userId,
 Map<String,Object> variables,
 Map<String,Object> variablesLocal,
 Map<String,Object> transientVariables,
 Map<String,Object> transientVariablesLocal)

Method Details

execute

protected Void execute(CommandContext commandContext,
 TaskEntity task)

Description copied from class: NeedsActiveTaskCmd

Subclasses must implement in this method their normal command logic. The provided task is ensured to be active.

Specified by:

execute in class NeedsActiveTaskCmd<Void>

isFormFieldValidationEnabled

protected boolean isFormFieldValidationEnabled(TaskEntity task)

completeTask

protected void completeTask(CommandContext commandContext,
 TaskEntity task,
 Map<String,Object> taskVariables)

getSuspendedTaskExceptionPrefix

protected String getSuspendedTaskExceptionPrefix()

Description copied from class: NeedsActiveTaskCmd

Subclasses can override this method to provide a customized exception message that will be thrown when the task is suspended.

Overrides:

getSuspendedTaskExceptionPrefix in class NeedsActiveTaskCmd<Void>