Package org.camunda.bpm.engine.runtime

Interface ModificationBuilder

All Superinterfaces:
InstantiationBuilder<ModificationBuilder>
All Known Implementing Classes:
ModificationBuilderImpl
public interface ModificationBuilder extends InstantiationBuilder<ModificationBuilder>

  • Method Details

    • cancelAllForActivity

      ModificationBuilder cancelAllForActivity(String activityId)

      Submits the instruction:

      Cancel all instances of the given activity in an arbitrary order, which are:

      • activity instances of that activity
      • transition instances entering or leaving that activity

      The cancellation order of the instances is arbitrary

      Parameters:
      activityId - the activity for which all instances should be cancelled

    • cancelAllForActivity

      ModificationBuilder cancelAllForActivity(String activityId, boolean cancelCurrentActiveActivityInstances)

      Submits the instruction:

      Cancel all instances of the given activity in an arbitrary order, which are:

      • activity instances of that activity
      • transition instances entering or leaving that activity

      The cancellation order of the instances is arbitrary

      Parameters:
      activityId - the activity for which all instances should be cancelled
      cancelCurrentActiveActivityInstances -

    • processInstanceIds

      ModificationBuilder processInstanceIds(List<String> processInstanceIds)
      Parameters:
      processInstanceIds - the process instance ids to modify.

    • processInstanceIds

      ModificationBuilder processInstanceIds(String... processInstanceIds)
      Parameters:
      processInstanceIds - the process instance ids to modify.

    • processInstanceQuery

      ModificationBuilder processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
      Parameters:
      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.

    • skipCustomListeners

      ModificationBuilder skipCustomListeners()
      Skips custom execution listeners when creating/removing activity instances during modification

    • skipIoMappings

      ModificationBuilder skipIoMappings()
      Skips io mappings when creating/removing activity instances during modification

    • setAnnotation

      ModificationBuilder setAnnotation(String annotation)
      Provides annotation for the current modification.

    • execute

      void execute()
      Execute the modification synchronously.
      Throws:
      AuthorizationException - if the user has not all of the following permissions
      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()
      Execute the modification asynchronously as batch. The returned batch can be used to track the progress of the modification.
      Returns:
      the batch which executes the modification asynchronously.
      Throws:
      AuthorizationException - if the user has not all of the following permissions

    • historicProcessInstanceQuery

      ModificationBuilder historicProcessInstanceQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)
      Parameters:
      historicProcessInstanceQuery - a query which selects the process instances to modify. It is advised to include the `unfinished` filter in the historicProcessInstanceQuery as finished instances cause failures for the modification. Query results are restricted to process instances for which the user has Permissions.READ_HISTORY permission.