public interface ModificationBuilder extends InstantiationBuilder<ModificationBuilder>
Modifier and Type | Method and Description |
---|---|
ModificationBuilder |
cancelAllForActivity(String activityId)
Submits the instruction:
|
ModificationBuilder |
cancelAllForActivity(String activityId,
boolean cancelCurrentActiveActivityInstances)
Submits the instruction:
|
void |
execute()
Execute the modification synchronously.
|
Batch |
executeAsync()
Execute the modification asynchronously as batch.
|
ModificationBuilder |
processInstanceIds(List<String> processInstanceIds) |
ModificationBuilder |
processInstanceIds(String... processInstanceIds) |
ModificationBuilder |
processInstanceQuery(ProcessInstanceQuery processInstanceQuery) |
ModificationBuilder |
setAnnotation(String annotation)
Provides annotation for the current modification.
|
ModificationBuilder |
skipCustomListeners()
Skips custom execution listeners when creating/removing activity instances during modification
|
ModificationBuilder |
skipIoMappings()
Skips io mappings when creating/removing activity instances during modification
|
startAfterActivity, startBeforeActivity, startTransition
ModificationBuilder cancelAllForActivity(String activityId)
Submits the instruction:
Cancel all instances of the given activity in an arbitrary order, which are:
The cancellation order of the instances is arbitrary
activityId
- the activity for which all instances should be cancelledModificationBuilder cancelAllForActivity(String activityId, boolean cancelCurrentActiveActivityInstances)
Submits the instruction:
Cancel all instances of the given activity in an arbitrary order, which are:
The cancellation order of the instances is arbitrary
activityId
- the activity for which all instances should be cancelledcancelCurrentActiveActivityInstances
- ModificationBuilder processInstanceIds(List<String> processInstanceIds)
processInstanceIds
- the process instance ids to modify.ModificationBuilder processInstanceIds(String... processInstanceIds)
processInstanceIds
- the process instance ids to modify.ModificationBuilder processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
processInstanceQuery
- a query which selects the process instances to modify.
Query results are restricted to process instances for which the user has Permissions.READ
permission.ModificationBuilder skipCustomListeners()
ModificationBuilder skipIoMappings()
ModificationBuilder setAnnotation(String annotation)
void execute()
AuthorizationException
- if the user has not all of the following permissions
Permissions.UPDATE
permission on Resources.PROCESS_INSTANCE
or no 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 executeAsync()
instead.Batch executeAsync()
AuthorizationException
- if the user has not all of the following permissions
Copyright © 2022. All rights reserved.