Package org.camunda.bpm.engine.history

Interface SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

All Superinterfaces:

SetRemovalTimeToHistoricDecisionInstancesBuilder

All Known Implementing Classes:

SetRemovalTimeToHistoricDecisionInstancesBuilderImpl

public interface SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
extends SetRemovalTimeToHistoricDecisionInstancesBuilder

Fluent builder to select the mode to set the removal time for historic decision instances.

Author:

Tassilo Weidner

Method Summary

Modifier and Type	Method	Description
SetRemovalTimeToHistoricDecisionInstancesBuilder	absoluteRemovalTime(Date removalTime)	Sets the removal time to an absolute date.
SetRemovalTimeToHistoricDecisionInstancesBuilder	calculatedRemovalTime()	Calculates the removal time dynamically based on the respective decision definition time to live and the engine's removal time strategy.
SetRemovalTimeToHistoricDecisionInstancesBuilder	clearedRemovalTime()	Sets the removal time to null.

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

byIds, byQuery, executeAsync, hierarchical

Method Details

absoluteRemovalTime

SetRemovalTimeToHistoricDecisionInstancesBuilder absoluteRemovalTime(Date removalTime)

Sets the removal time to an absolute date.

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

SetRemovalTimeToHistoricDecisionInstancesBuilder calculatedRemovalTime()

Calculates the removal time dynamically based on the respective decision definition time to live and the engine's removal time strategy.

In case SetRemovalTimeToHistoricDecisionInstancesBuilder.hierarchical() is enabled, the removal time is being calculated based on the base time and time to live of the historic root decision instance.

Returns:

the builder.

clearedRemovalTime

SetRemovalTimeToHistoricDecisionInstancesBuilder clearedRemovalTime()

Sets the removal time to null.

Returns:

the builder.