Class SetRemovalTimeToHistoricDecisionInstancesBuilderImpl
java.lang.Object
org.camunda.bpm.engine.impl.history.SetRemovalTimeToHistoricDecisionInstancesBuilderImpl
- All Implemented Interfaces:
SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
,SetRemovalTimeToHistoricDecisionInstancesBuilder
public class SetRemovalTimeToHistoricDecisionInstancesBuilderImpl
extends Object
implements SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
- Author:
- Tassilo Weidner
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
-
Field Summary
Modifier and TypeFieldDescriptionprotected CommandExecutor
protected boolean
protected HistoricDecisionInstanceQuery
protected Date
-
Constructor Summary
ConstructorDescriptionSetRemovalTimeToHistoricDecisionInstancesBuilderImpl
(CommandExecutor commandExecutor) -
Method Summary
Modifier and TypeMethodDescriptionabsoluteRemovalTime
(Date removalTime) Sets the removal time to an absolute date.Selects historic process instances by the given ids.Selects historic decision instances by the given query.Calculates the removal time dynamically based on the respective decision definition time to live and the engine's removal time strategy.Sets the removal time tonull
.Sets the removal time asynchronously as batch.getIds()
getMode()
getQuery()
Takes additionally historic decision instances into account that are part of the hierarchy of the given historic decision instances.boolean
-
Field Details
-
query
-
ids
-
removalTime
-
mode
-
isHierarchical
protected boolean isHierarchical -
commandExecutor
-
-
Constructor Details
-
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl
-
-
Method Details
-
byQuery
public SetRemovalTimeToHistoricDecisionInstancesBuilder byQuery(HistoricDecisionInstanceQuery query) Description copied from interface:SetRemovalTimeToHistoricDecisionInstancesBuilder
Selects historic decision instances by the given query.- Specified by:
byQuery
in interfaceSetRemovalTimeToHistoricDecisionInstancesBuilder
- Parameters:
query
- to be evaluated.- Returns:
- the builder.
-
byIds
Description copied from interface:SetRemovalTimeToHistoricDecisionInstancesBuilder
Selects historic process instances by the given ids.- Specified by:
byIds
in interfaceSetRemovalTimeToHistoricDecisionInstancesBuilder
- Parameters:
ids
- supposed to be affected.- Returns:
- the builder.
-
absoluteRemovalTime
Description copied from interface:SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
Sets the removal time to an absolute date.- Specified by:
absoluteRemovalTime
in interfaceSetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
- Parameters:
removalTime
- supposed to be set to historic entities.- Returns:
- the builder.
-
calculatedRemovalTime
Description copied from interface:SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
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.- Specified by:
calculatedRemovalTime
in interfaceSetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
- Returns:
- the builder.
-
clearedRemovalTime
Description copied from interface:SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
Sets the removal time to
null
.- Specified by:
clearedRemovalTime
in interfaceSetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder
- Returns:
- the builder.
-
hierarchical
Description copied from interface:SetRemovalTimeToHistoricDecisionInstancesBuilder
Takes additionally historic decision instances into account that are part of the hierarchy of the given historic decision instances. If the root decision instance id of the given historic decision instance isnull
, the hierarchy is ignored. This is the case for instances that were started with a version prior 7.10.- Specified by:
hierarchical
in interfaceSetRemovalTimeToHistoricDecisionInstancesBuilder
- Returns:
- the builder.
-
executeAsync
Description copied from interface:SetRemovalTimeToHistoricDecisionInstancesBuilder
Sets the removal time asynchronously as batch. The returned batch can be used to track the progress of setting a removal time.- Specified by:
executeAsync
in interfaceSetRemovalTimeToHistoricDecisionInstancesBuilder
- Returns:
- the batch which sets the removal time asynchronously.
-
getQuery
-
getIds
-
getRemovalTime
-
getMode
-
isHierarchical
public boolean isHierarchical()
-