org.camunda.bpm.engine.history

Interface SetRemovalTimeToHistoricProcessInstancesBuilder

All Known Subinterfaces:

SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

All Known Implementing Classes:

SetRemovalTimeToHistoricProcessInstancesBuilderImpl

public interface SetRemovalTimeToHistoricProcessInstancesBuilder

Fluent builder to set the removal time to historic process instances and all associated historic entities.

Author:

Tassilo Weidner

Method Summary

Modifier and Type	Method and Description
SetRemovalTimeToHistoricProcessInstancesBuilder	byIds(String... historicProcessInstanceIds) Selects historic decision instances by the given ids.
SetRemovalTimeToHistoricProcessInstancesBuilder	byQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery) Selects historic process instances by the given query.
Batch	executeAsync() Sets the removal time asynchronously as batch.
SetRemovalTimeToHistoricProcessInstancesBuilder	hierarchical() Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance.

Method Detail

byQuery

SetRemovalTimeToHistoricProcessInstancesBuilder byQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)

Selects historic process instances by the given query.

Parameters:

historicProcessInstanceQuery - to be evaluated.

Returns:

the builder.

byIds

SetRemovalTimeToHistoricProcessInstancesBuilder byIds(String... historicProcessInstanceIds)

Selects historic decision instances by the given ids.

Parameters:

historicProcessInstanceIds - supposed to be affected.

Returns:

the builder.

hierarchical

SetRemovalTimeToHistoricProcessInstancesBuilder hierarchical()

Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance. If the root process instance id of the given historic process instance is null, the hierarchy is ignored. This is the case for instances that were started with a version prior 7.10.

Returns:

the builder.

executeAsync

Batch executeAsync()

Sets the removal time asynchronously as batch. The returned batch can be used to track the progress of setting a removal time.

Returns:

the batch which sets the removal time asynchronously.

Throws:

BadUserRequestException - when no historic process instances could be found.

AuthorizationException - when no CREATE_BATCH_SET_REMOVAL_TIME or no permission CREATE permission is granted on Resources.BATCH.