SetRemovalTimeSelectModeForHistoricBatchesBuilder (Camunda Platform Javadocs 7.20.0-SNAPSHOT)

All Superinterfaces:

SetRemovalTimeToHistoricBatchesBuilder

All Known Implementing Classes:

SetRemovalTimeToHistoricBatchesBuilderImpl
```
public interface SetRemovalTimeSelectModeForHistoricBatchesBuilder
extends SetRemovalTimeToHistoricBatchesBuilder
```
Fluent builder to select the mode to set the removal time for historic batches.

Author:

Tassilo Weidner

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SetRemovalTimeToHistoricBatchesBuilder`	`absoluteRemovalTime(Date removalTime)`	Sets the removal time to an absolute date.
`SetRemovalTimeToHistoricBatchesBuilder`	`calculatedRemovalTime()`	Calculates the removal time dynamically based on the time to live of the respective batch and the engine's removal time strategy.
`SetRemovalTimeToHistoricBatchesBuilder`	`clearedRemovalTime()`	Sets the removal time to `null`.

Methods inherited from interface org.camunda.bpm.engine.history.SetRemovalTimeToHistoricBatchesBuilder
byIds, byQuery, executeAsync

- Method Detail
  - absoluteRemovalTime
```
SetRemovalTimeToHistoricBatchesBuilder absoluteRemovalTime(Date removalTime)
```
    Sets the removal time to an absolute date.
    
    Parameters:
    
    removalTime - supposed to be set to historic entities.
    
    Returns:
    
    the builder.
  - calculatedRemovalTime
```
SetRemovalTimeToHistoricBatchesBuilder calculatedRemovalTime()
```
    Calculates the removal time dynamically based on the time to live of the respective batch and the engine's removal time strategy.
    
    Returns:
    
    the builder.
  - clearedRemovalTime
```
SetRemovalTimeToHistoricBatchesBuilder clearedRemovalTime()
```
    Sets the removal time to null.
    
    Returns:
    
    the builder.