Package org.camunda.bpm.engine.impl.history

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

Nested Classes

Modifier and Type	Class	Description
static enum	SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected List<String>	ids
protected boolean	isHierarchical
protected SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.Mode	mode
protected HistoricDecisionInstanceQuery	query
protected Date	removalTime

Constructor Summary

Constructors

Constructor	Description
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
SetRemovalTimeToHistoricDecisionInstancesBuilder	absoluteRemovalTime(Date removalTime)	Sets the removal time to an absolute date.
SetRemovalTimeToHistoricDecisionInstancesBuilder	byIds(String... ids)	Selects historic process instances by the given ids.
SetRemovalTimeToHistoricDecisionInstancesBuilder	byQuery(HistoricDecisionInstanceQuery query)	Selects historic decision instances by the given query.
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.
Batch	executeAsync()	Sets the removal time asynchronously as batch.
List<String>	getIds()
SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.Mode	getMode()
HistoricDecisionInstanceQuery	getQuery()
Date	getRemovalTime()
SetRemovalTimeToHistoricDecisionInstancesBuilder	hierarchical()	Takes additionally historic decision instances into account that are part of the hierarchy of the given historic decision instances.
boolean	isHierarchical()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

query

protected HistoricDecisionInstanceQuery query

ids

protected List<String> ids

removalTime

protected Date removalTime

mode

protected SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.Mode mode

isHierarchical

protected boolean isHierarchical

commandExecutor

protected CommandExecutor commandExecutor

Constructor Details

SetRemovalTimeToHistoricDecisionInstancesBuilderImpl

public SetRemovalTimeToHistoricDecisionInstancesBuilderImpl(CommandExecutor commandExecutor)

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 interface SetRemovalTimeToHistoricDecisionInstancesBuilder

Parameters:

query - to be evaluated.

Returns:

the builder.

byIds

public SetRemovalTimeToHistoricDecisionInstancesBuilder byIds(String... ids)

Description copied from interface: SetRemovalTimeToHistoricDecisionInstancesBuilder

Selects historic process instances by the given ids.

Specified by:

byIds in interface SetRemovalTimeToHistoricDecisionInstancesBuilder

Parameters:

ids - supposed to be affected.

Returns:

the builder.

absoluteRemovalTime

public SetRemovalTimeToHistoricDecisionInstancesBuilder absoluteRemovalTime(Date removalTime)

Description copied from interface: SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

Sets the removal time to an absolute date.

Specified by:

absoluteRemovalTime in interface SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

public SetRemovalTimeToHistoricDecisionInstancesBuilder 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 interface SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

Returns:

the builder.

clearedRemovalTime

public SetRemovalTimeToHistoricDecisionInstancesBuilder clearedRemovalTime()

Description copied from interface: SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

Sets the removal time to null.

Specified by:

clearedRemovalTime in interface SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

Returns:

the builder.

hierarchical

public SetRemovalTimeToHistoricDecisionInstancesBuilder 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 is null, the hierarchy is ignored. This is the case for instances that were started with a version prior 7.10.

Specified by:

hierarchical in interface SetRemovalTimeToHistoricDecisionInstancesBuilder

Returns:

the builder.

executeAsync

public Batch 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 interface SetRemovalTimeToHistoricDecisionInstancesBuilder

Returns:

the batch which sets the removal time asynchronously.

getQuery

public HistoricDecisionInstanceQuery getQuery()

getIds

public List<String> getIds()

getRemovalTime

public Date getRemovalTime()

getMode

public SetRemovalTimeToHistoricDecisionInstancesBuilderImpl.Mode getMode()

isHierarchical

public boolean isHierarchical()