NeedsActiveTaskCmd (Flowable - CMMN Engine 6.8.1 API)

java.lang.Object
- org.flowable.cmmn.engine.impl.cmd.NeedsActiveTaskCmd<T>

All Implemented Interfaces:

Serializable, Command<T>

Direct Known Subclasses:

AddIdentityLinkCmd, ClaimTaskCmd, CompleteTaskWithFormCmd, DelegateTaskCmd, DeleteIdentityLinkCmd, RemoveTaskVariablesCmd, ResolveTaskCmd, SetTaskDueDateCmd, SetTaskPriorityCmd, SetTaskVariablesCmd
```
public abstract class NeedsActiveTaskCmd<T>
extends Object
implements Command<T>, Serializable
```
An abstract superclass for Command implementations that want to verify the provided task is always active (ie. not suspended).

Author:

Joram Barrez

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected String taskId

Constructor Summary

Constructors
Constructor Description

NeedsActiveTaskCmd(String taskId)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`execute(CommandContext commandContext)`
`protected abstract T`	`execute(CommandContext commandContext, TaskEntity task)`	Subclasses must implement in this method their normal command logic.
`protected String`	`getSuspendedTaskException()`	Subclasses can override this method to provide a customized exception message that will be thrown when the task is suspended.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - taskId
```
protected String taskId
```
- Constructor Detail
  - NeedsActiveTaskCmd
```
public NeedsActiveTaskCmd(String taskId)
```
- Method Detail
  - execute
```
public T execute(CommandContext commandContext)
```
    Specified by:
    
    execute in interface Command<T>
  - execute
```
protected abstract T execute(CommandContext commandContext,
                             TaskEntity task)
```
    Subclasses must implement in this method their normal command logic. The provided task is ensured to be active.
  - getSuspendedTaskException
```
protected String getSuspendedTaskException()
```
    Subclasses can override this method to provide a customized exception message that will be thrown when the task is suspended.