org.camunda.bpm.engine.impl.history

Class SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.history.SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl

All Implemented Interfaces:

SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

public class SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl
extends Object
implements SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Author:

Tassilo Weidner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected boolean	isHierarchical
protected SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl.Mode	mode
protected HistoricProcessInstanceQuery	query
protected Date	removalTime

Constructor Summary

Constructors

Constructor and Description
SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
SetRemovalTimeToHistoricProcessInstancesAsyncBuilder	absoluteRemovalTime(Date removalTime) Sets the removal time to an absolute date or null (clears the removal time).
SetRemovalTimeToHistoricProcessInstancesAsyncBuilder	byQuery(HistoricProcessInstanceQuery query) Selects historic process instances by the given query.
SetRemovalTimeToHistoricProcessInstancesAsyncBuilder	calculatedRemovalTime() Calculates the removal time dynamically based on the respective process definition time to live and the process engine's removal time strategy.
Batch	executeAsync() Sets the removal time asynchronously as batch.
SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl.Mode	getMode()
HistoricProcessInstanceQuery	getQuery()
Date	getRemovalTime()
SetRemovalTimeToHistoricProcessInstancesAsyncBuilder	hierarchical() Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance.
boolean	isHierarchical()

Methods inherited from class java.lang.Object

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

Field Detail

query

protected HistoricProcessInstanceQuery query

removalTime

protected Date removalTime

mode

protected SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl.Mode mode

isHierarchical

protected boolean isHierarchical

commandExecutor

protected CommandExecutor commandExecutor

Constructor Detail

SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl(CommandExecutor commandExecutor)

Method Detail

byQuery

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilder byQuery(HistoricProcessInstanceQuery query)

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Selects historic process instances by the given query.

Specified by:

byQuery in interface SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Parameters:

query - to be evaluated.

Returns:

the builder.

absoluteRemovalTime

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilder absoluteRemovalTime(Date removalTime)

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Sets the removal time to an absolute date or null (clears the removal time).

Specified by:

absoluteRemovalTime in interface SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilder calculatedRemovalTime()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

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

Specified by:

calculatedRemovalTime in interface SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Returns:

the builder.

hierarchical

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilder hierarchical()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance. If the root process instance id of the given historic process 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 SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Returns:

the builder.

executeAsync

public Batch executeAsync()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

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 SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Returns:

the batch which sets the removal time asynchronously.

getQuery

public HistoricProcessInstanceQuery getQuery()

getRemovalTime

public Date getRemovalTime()

getMode

public SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl.Mode getMode()

isHierarchical

public boolean isHierarchical()