org.camunda.bpm.engine.impl.runtime

Class UpdateProcessInstanceSuspensionStateBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.runtime.UpdateProcessInstanceSuspensionStateBuilderImpl

All Implemented Interfaces:

UpdateProcessInstancesRequest, UpdateProcessInstanceSuspensionStateBuilder, UpdateProcessInstanceSuspensionStateSelectBuilder, UpdateProcessInstanceSuspensionStateTenantBuilder

public class UpdateProcessInstanceSuspensionStateBuilderImpl
extends Object
implements UpdateProcessInstanceSuspensionStateBuilder, UpdateProcessInstanceSuspensionStateSelectBuilder, UpdateProcessInstanceSuspensionStateTenantBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected boolean	isProcessDefinitionTenantIdSet
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processDefinitionTenantId
protected String	processInstanceId

Constructor Summary

Constructors

Constructor and Description
UpdateProcessInstanceSuspensionStateBuilderImpl() Creates a builder without CommandExecutor which can not be used to update the suspension state via activate() or suspend().
UpdateProcessInstanceSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the provided process instances.
UpdateProcessInstancesSuspensionStateBuilder	byHistoricProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects a list of process instances with the given a historical process instance query.
UpdateProcessInstanceSuspensionStateBuilderImpl	byProcessDefinitionId(String processDefinitionId) Selects the instances of the process definition with the given id.
UpdateProcessInstanceSuspensionStateBuilderImpl	byProcessDefinitionKey(String processDefinitionKey) Selects the instances of the process definitions with the given key.
UpdateProcessInstanceSuspensionStateBuilderImpl	byProcessInstanceId(String processInstanceId) Selects the process instance with the given id.
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.
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessDefinitionTenantId()
String	getProcessInstanceId()
boolean	isProcessDefinitionTenantIdSet()
UpdateProcessInstanceSuspensionStateBuilderImpl	processDefinitionTenantId(String tenantId) Specify the id of the tenant the process definition belongs to.
UpdateProcessInstanceSuspensionStateBuilderImpl	processDefinitionWithoutTenantId() Specify that the process definition belongs to no tenant.
void	suspend() Suspends the provided process instances.
protected void	validateParameters()

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutor

protected final CommandExecutor commandExecutor

processInstanceId

protected String processInstanceId

processDefinitionKey

protected String processDefinitionKey

processDefinitionId

protected String processDefinitionId

processDefinitionTenantId

protected String processDefinitionTenantId

isProcessDefinitionTenantIdSet

protected boolean isProcessDefinitionTenantIdSet

Constructor Detail

UpdateProcessInstanceSuspensionStateBuilderImpl

public UpdateProcessInstanceSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

UpdateProcessInstanceSuspensionStateBuilderImpl

public UpdateProcessInstanceSuspensionStateBuilderImpl()

Creates a builder without CommandExecutor which can not be used to update the suspension state via activate() or suspend(). Can be used in combination with your own command.

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

byProcessInstanceId

public UpdateProcessInstanceSuspensionStateBuilderImpl byProcessInstanceId(String processInstanceId)

Description copied from interface: UpdateProcessInstanceSuspensionStateSelectBuilder

Selects the process instance with the given id.

Specified by:

byProcessInstanceId in interface UpdateProcessInstanceSuspensionStateSelectBuilder

Parameters:

processInstanceId - id of the process instance

Returns:

the builder

byProcessDefinitionId

public UpdateProcessInstanceSuspensionStateBuilderImpl byProcessDefinitionId(String processDefinitionId)

Description copied from interface: UpdateProcessInstanceSuspensionStateSelectBuilder

Selects the instances of the process definition with the given id.

Specified by:

byProcessDefinitionId in interface UpdateProcessInstanceSuspensionStateSelectBuilder

Parameters:

processDefinitionId - id of the process definition

Returns:

the builder

byProcessDefinitionKey

public UpdateProcessInstanceSuspensionStateBuilderImpl byProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: UpdateProcessInstanceSuspensionStateSelectBuilder

Selects the instances of the process definitions with the given key.

Specified by:

byProcessDefinitionKey in interface UpdateProcessInstanceSuspensionStateSelectBuilder

Parameters:

processDefinitionKey - key of the process definition

Returns:

the builder

processDefinitionWithoutTenantId

public UpdateProcessInstanceSuspensionStateBuilderImpl processDefinitionWithoutTenantId()

Description copied from interface: UpdateProcessInstanceSuspensionStateTenantBuilder

Specify that the process definition belongs to no tenant.

Specified by:

processDefinitionWithoutTenantId in interface UpdateProcessInstanceSuspensionStateTenantBuilder

Returns:

the builder

processDefinitionTenantId

public UpdateProcessInstanceSuspensionStateBuilderImpl processDefinitionTenantId(String tenantId)

Description copied from interface: UpdateProcessInstanceSuspensionStateTenantBuilder

Specify the id of the tenant the process definition belongs to.

Specified by:

processDefinitionTenantId in interface UpdateProcessInstanceSuspensionStateTenantBuilder

Parameters:

tenantId - the id of the tenant

Returns:

the builder

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

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

validateParameters

protected void validateParameters()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionTenantId

public String getProcessDefinitionTenantId()

isProcessDefinitionTenantIdSet

public boolean isProcessDefinitionTenantIdSet()

getProcessInstanceId

public String getProcessInstanceId()