Package org.camunda.bpm.engine.history
Interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder
- All Superinterfaces:
SetRemovalTimeToHistoricProcessInstancesBuilder
- All Known Implementing Classes:
SetRemovalTimeToHistoricProcessInstancesBuilderImpl
public interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder
extends SetRemovalTimeToHistoricProcessInstancesBuilder
Fluent builder to select the mode to set the removal time for historic process instances.
- Author:
- Tassilo Weidner
-
Method Summary
Modifier and TypeMethodDescriptionabsoluteRemovalTime(Date removalTime) Sets the removal time to an absolute date.Calculates the removal time dynamically based on the respective process definition time to live and the process engine's removal time strategy.Sets the removal time tonull.Methods inherited from interface org.camunda.bpm.engine.history.SetRemovalTimeToHistoricProcessInstancesBuilder
byIds, byQuery, chunkSize, executeAsync, hierarchical, updateInChunks
-
Method Details
-
absoluteRemovalTime
Sets the removal time to an absolute date.- Parameters:
removalTime- supposed to be set to historic entities.- Returns:
- the builder.
-
calculatedRemovalTime
SetRemovalTimeToHistoricProcessInstancesBuilder calculatedRemovalTime()Calculates the removal time dynamically based on the respective process definition time to live and the process engine's removal time strategy.
In case
SetRemovalTimeToHistoricProcessInstancesBuilder.hierarchical()is enabled, the removal time is being calculated based on the base time and time to live of the historic root process instance.- Returns:
- the builder.
-
clearedRemovalTime
SetRemovalTimeToHistoricProcessInstancesBuilder clearedRemovalTime()Sets the removal time to
null.- Returns:
- the builder.
-