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 Type	Method and Description
SetRemovalTimeToHistoricProcessInstancesBuilder	absoluteRemovalTime(Date removalTime) Sets the removal time to an absolute date.
SetRemovalTimeToHistoricProcessInstancesBuilder	calculatedRemovalTime() Calculates the removal time dynamically based on the respective process definition time to live and the process engine's removal time strategy.
SetRemovalTimeToHistoricProcessInstancesBuilder	clearedRemovalTime() Sets the removal time to null.

Methods inherited from interface org.camunda.bpm.engine.history.SetRemovalTimeToHistoricProcessInstancesBuilder

byIds, byQuery, executeAsync, hierarchical

Method Detail

absoluteRemovalTime

SetRemovalTimeToHistoricProcessInstancesBuilder absoluteRemovalTime(Date removalTime)

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.