org.camunda.bpm.engine.runtime

Interface RestartProcessInstanceBuilder

All Superinterfaces:

InstantiationBuilder<RestartProcessInstanceBuilder>

All Known Implementing Classes:

RestartProcessInstanceBuilderImpl

public interface RestartProcessInstanceBuilder
extends InstantiationBuilder<RestartProcessInstanceBuilder>

Author:

Anna Pazola

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the restart synchronously.
Batch	executeAsync() Executes the restart asynchronously as batch.
RestartProcessInstanceBuilder	historicProcessInstanceQuery(HistoricProcessInstanceQuery query)
RestartProcessInstanceBuilder	initialSetOfVariables() Sets the initial set of variables during restart.
RestartProcessInstanceBuilder	processInstanceIds(List<String> processInstanceIds)
RestartProcessInstanceBuilder	processInstanceIds(String... processInstanceIds)
RestartProcessInstanceBuilder	skipCustomListeners() Skips custom execution listeners when creating activity instances during restart
RestartProcessInstanceBuilder	skipIoMappings() Skips io mappings when creating activity instances during restart
RestartProcessInstanceBuilder	withoutBusinessKey() Does not take over the business key of the historic process instance

Methods inherited from interface org.camunda.bpm.engine.runtime.InstantiationBuilder

startAfterActivity, startBeforeActivity, startTransition

Method Detail

historicProcessInstanceQuery

RestartProcessInstanceBuilder historicProcessInstanceQuery(HistoricProcessInstanceQuery query)

Parameters:

query - a query which selects the historic process instances to restart. Query results are restricted to process instances for which the user has Permissions.READ_HISTORY permission.

processInstanceIds

RestartProcessInstanceBuilder processInstanceIds(String... processInstanceIds)

Parameters:

processInstanceIds - the process instance ids to restart.

processInstanceIds

RestartProcessInstanceBuilder processInstanceIds(List<String> processInstanceIds)

Parameters:

processInstanceIds - the process instance ids to restart.

initialSetOfVariables

RestartProcessInstanceBuilder initialSetOfVariables()

Sets the initial set of variables during restart. By default, the last set of variables is used

withoutBusinessKey

RestartProcessInstanceBuilder withoutBusinessKey()

Does not take over the business key of the historic process instance

skipCustomListeners

RestartProcessInstanceBuilder skipCustomListeners()

Skips custom execution listeners when creating activity instances during restart

skipIoMappings

RestartProcessInstanceBuilder skipIoMappings()

Skips io mappings when creating activity instances during restart

execute

void execute()

Executes the restart synchronously.

Throws:

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 executeAsync() instead.

executeAsync

Batch executeAsync()

Executes the restart asynchronously as batch. The returned batch can be used to track the progress of the restart.

Returns:

the batch which executes the restart asynchronously.

Throws:

AuthorizationException - if the user has not all of the following permissions

• Permissions.CREATE or BatchPermissions.CREATE_BATCH_RESTART_PROCESS_INSTANCES permission on Resources.BATCH