Package org.camunda.bpm.engine.runtime

Interface UpdateProcessInstanceSuspensionStateBuilder

All Known Subinterfaces:

UpdateProcessInstancesSuspensionStateBuilder, UpdateProcessInstanceSuspensionStateTenantBuilder

All Known Implementing Classes:

UpdateProcessInstancesSuspensionStateBuilderImpl, UpdateProcessInstanceSuspensionStateBuilderImpl

public interface UpdateProcessInstanceSuspensionStateBuilder

Fluent builder to update the suspension state of process instances.

Method Summary

Modifier and Type	Method	Description
void	activate()	Activates the provided process instances.
void	suspend()	Suspends the provided process instances.

Method Details

activate

void activate()

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.

Throws:

ProcessEngineException - If no such processDefinition can be found.

AuthorizationException - if the user has none of the following:

ProcessInstancePermissions.SUSPEND permission on Resources.PROCESS_INSTANCE

ProcessDefinitionPermissions.SUSPEND_INSTANCE permission on Resources.PROCESS_DEFINITION

Permissions.UPDATE permission on Resources.PROCESS_INSTANCE

Permissions.UPDATE_INSTANCE permission on Resources.PROCESS_DEFINITION

BadUserRequestException - When the affected instances count exceeds the maximum results limit. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE). Please use the batch operation UpdateProcessInstancesSuspensionStateBuilder.activateAsync() instead.

suspend

void suspend()

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.

Throws:

ProcessEngineException - If no such processDefinition can be found.

AuthorizationException - if the user has none of the following:

ProcessInstancePermissions.SUSPEND permission on Resources.PROCESS_INSTANCE

ProcessDefinitionPermissions.SUSPEND_INSTANCE permission on Resources.PROCESS_DEFINITION

Permissions.UPDATE permission on Resources.PROCESS_INSTANCE

Permissions.UPDATE_INSTANCE permission on Resources.PROCESS_DEFINITION

BadUserRequestException - When the affected instances count exceeds the maximum results limit. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE). Please see the batch operation UpdateProcessInstancesSuspensionStateBuilder.suspendAsync() instead.