org.camunda.bpm.engine.impl

Class UpdateProcessInstancesSuspensionStateBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.UpdateProcessInstancesSuspensionStateBuilderImpl

All Implemented Interfaces:

UpdateProcessInstancesRequest, UpdateProcessInstancesSuspensionStateBuilder, UpdateProcessInstanceSuspensionStateBuilder

public class UpdateProcessInstancesSuspensionStateBuilderImpl
extends Object
implements UpdateProcessInstancesSuspensionStateBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected HistoricProcessInstanceQuery	historicProcessInstanceQuery
protected String	processDefinitionId
protected List<String>	processInstanceIds
protected ProcessInstanceQuery	processInstanceQuery

Constructor Summary

Constructors

Constructor and Description
UpdateProcessInstancesSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates the provided process instances.
Batch	activateAsync() Activates the provided process instances asynchronously.
UpdateProcessInstancesSuspensionStateBuilder	byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects a list of process instances with the given a historical process instance query.
UpdateProcessInstancesSuspensionStateBuilder	byProcessInstanceIds(List<String> processInstanceIds) Selects a list of process instances with the given list of ids.
UpdateProcessInstancesSuspensionStateBuilder	byProcessInstanceIds(String... processInstanceIds) Selects a list of process instances with the given list of ids.
UpdateProcessInstancesSuspensionStateBuilder	byProcessInstanceQuery(ProcessInstanceQuery processInstanceQuery) Selects a list of process instances with the given a process instance query.
HistoricProcessInstanceQuery	getHistoricProcessInstanceQuery()
List<String>	getProcessInstanceIds()
ProcessInstanceQuery	getProcessInstanceQuery()
void	suspend() Suspends the provided process instances.
Batch	suspendAsync() Suspends the provided process instances asynchronously.

Methods inherited from class java.lang.Object

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

Field Detail

processInstanceIds

protected List<String> processInstanceIds

processInstanceQuery

protected ProcessInstanceQuery processInstanceQuery

historicProcessInstanceQuery

protected HistoricProcessInstanceQuery historicProcessInstanceQuery

commandExecutor

protected CommandExecutor commandExecutor

processDefinitionId

protected String processDefinitionId

Constructor Detail

UpdateProcessInstancesSuspensionStateBuilderImpl

public UpdateProcessInstancesSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

Method Detail

byProcessInstanceIds

public UpdateProcessInstancesSuspensionStateBuilder byProcessInstanceIds(List<String> processInstanceIds)

Description copied from interface: UpdateProcessInstancesRequest

Selects a list of process instances with the given list of ids.

Specified by:

byProcessInstanceIds in interface UpdateProcessInstancesRequest

Parameters:

processInstanceIds - list of ids of the process instances

Returns:

the builder

byProcessInstanceIds

public UpdateProcessInstancesSuspensionStateBuilder byProcessInstanceIds(String... processInstanceIds)

Description copied from interface: UpdateProcessInstancesRequest

Selects a list of process instances with the given list of ids.

Specified by:

byProcessInstanceIds in interface UpdateProcessInstancesRequest

Parameters:

processInstanceIds - list of ids of the process instances

Returns:

the builder

byProcessInstanceQuery

public UpdateProcessInstancesSuspensionStateBuilder byProcessInstanceQuery(ProcessInstanceQuery processInstanceQuery)

Description copied from interface: UpdateProcessInstancesRequest

Selects a list of process instances with the given a process instance query.

Specified by:

byProcessInstanceQuery in interface UpdateProcessInstancesRequest

Parameters:

processInstanceQuery - process instance query that discribes a list of the process instances

Returns:

the builder

byHistoricProcessInstanceQuery

public UpdateProcessInstancesSuspensionStateBuilder byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)

Description copied from interface: UpdateProcessInstancesRequest

Selects a list of process instances with the given a historical process instance query.

Specified by:

byHistoricProcessInstanceQuery in interface UpdateProcessInstancesRequest

Parameters:

historicProcessInstanceQuery - historical process instance query that discribes a list of the process instances

Returns:

the builder

suspend

public void suspend()

Description copied from interface: UpdateProcessInstanceSuspensionStateBuilder

Suspends the provided process instances. This means that the execution is stopped, so the token state will not change. However, actions that do not change token state, like setting/removing variables, etc. will succeed.

Tasks belonging to the suspended process instance will also be suspended. This means that any actions influencing the tasks' lifecycles will fail, such as

• claiming
• completing
• delegation
• changes in task assignees, owners, etc.

Actions that only change task properties will succeed, such as changing variables or adding comments.

If a process instance is in state suspended, the engine will also not execute jobs (timers, messages) associated with this instance.

If you have a process instance hierarchy, suspending one process instance from the hierarchy will not suspend other process instances from that hierarchy.

Specified by:

suspend in interface UpdateProcessInstanceSuspensionStateBuilder

activate

public void activate()

Description copied from interface: UpdateProcessInstanceSuspensionStateBuilder

Activates the provided process instances.

If you have a process instance hierarchy, activating one process instance from the hierarchy will not activate other process instances from that hierarchy.

Specified by:

activate in interface UpdateProcessInstanceSuspensionStateBuilder

suspendAsync

public Batch suspendAsync()

Description copied from interface: UpdateProcessInstancesSuspensionStateBuilder

Suspends the provided process instances asynchronously. This means that the execution is stopped, so the token state will not change. However, actions that do not change token state, like setting/removing variables, etc. will succeed.

Tasks belonging to the suspended process instance will also be suspended. This means that any actions influencing the tasks' lifecycles will fail, such as

• claiming
• completing
• delegation
• changes in task assignees, owners, etc.

Actions that only change task properties will succeed, such as changing variables or adding comments.

If a process instance is in state suspended, the engine will also not execute jobs (timers, messages) associated with this instance.

If you have a process instance hierarchy, suspending one process instance from the hierarchy will not suspend other process instances from that hierarchy.

Specified by:

suspendAsync in interface UpdateProcessInstancesSuspensionStateBuilder

activateAsync

public Batch activateAsync()

Description copied from interface: UpdateProcessInstancesSuspensionStateBuilder

Activates the provided process instances asynchronously.

If you have a process instance hierarchy, activating one process instance from the hierarchy will not activate other process instances from that hierarchy.

Specified by:

activateAsync in interface UpdateProcessInstancesSuspensionStateBuilder

getProcessInstanceIds

public List<String> getProcessInstanceIds()

getProcessInstanceQuery

public ProcessInstanceQuery getProcessInstanceQuery()

getHistoricProcessInstanceQuery

public HistoricProcessInstanceQuery getHistoricProcessInstanceQuery()