org.camunda.bpm.engine.repository

Interface UpdateProcessDefinitionSuspensionStateBuilder

All Known Subinterfaces:

UpdateProcessDefinitionSuspensionStateTenantBuilder

All Known Implementing Classes:

UpdateProcessDefinitionSuspensionStateBuilderImpl

public interface UpdateProcessDefinitionSuspensionStateBuilder

Fluent builder to update the suspension state of process definitions.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the provided process definitions.
UpdateProcessDefinitionSuspensionStateBuilder	executionDate(Date executionDate) Specify when the suspension state should be updated.
UpdateProcessDefinitionSuspensionStateBuilder	includeProcessInstances(boolean includeProcessInstances) Specify if the suspension states of the process instances of the provided process definitions should also be updated.
void	suspend() Suspends the provided process definitions.

Method Detail

includeProcessInstances

UpdateProcessDefinitionSuspensionStateBuilder includeProcessInstances(boolean includeProcessInstances)

Specify if the suspension states of the process instances of the provided process definitions should also be updated. Default is false.

Parameters:

includeProcessInstances - if true, all related process instances will be activated / suspended too.

Returns:

the builder

executionDate

UpdateProcessDefinitionSuspensionStateBuilder executionDate(Date executionDate)

Specify when the suspension state should be updated. Note that the job executor needs to be active to use this.

Parameters:

executionDate - the date on which the process definition will be activated / suspended. If null, the process definition is activated / suspended immediately.

Returns:

the builder

activate

void activate()

Activates the provided process definitions.

Throws:

ProcessEngineException - If no such processDefinition can be found.

AuthorizationException -

if the user has none of the following:

• ProcessDefinitionPermissions.SUSPEND permission on Resources.PROCESS_DEFINITION
• Permissions.UPDATE permission on Resources.PROCESS_DEFINITION

if includeProcessInstances(boolean) is set to true and 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

suspend

void suspend()

Suspends the provided process definitions. If a process definition is in state suspended, it will not be possible to start new process instances based on this process definition.

Throws:

ProcessEngineException - If no such processDefinition can be found.

AuthorizationException -

if the user has none of the following:

• ProcessDefinitionPermissions.SUSPEND permission on Resources.PROCESS_DEFINITION
• Permissions.UPDATE permission on Resources.PROCESS_DEFINITION

if includeProcessInstances(boolean) is set to true and 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