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

Class SetRemovalTimeToHistoricProcessInstancesBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.history.SetRemovalTimeToHistoricProcessInstancesBuilderImpl

All Implemented Interfaces:

SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder, SetRemovalTimeToHistoricProcessInstancesBuilder

public class SetRemovalTimeToHistoricProcessInstancesBuilderImpl
extends Object
implements SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Author:

Tassilo Weidner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SetRemovalTimeToHistoricProcessInstancesBuilderImpl.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	chunkSize
protected CommandExecutor	commandExecutor
protected List<String>	ids
protected boolean	isHierarchical
protected SetRemovalTimeToHistoricProcessInstancesBuilderImpl.Mode	mode
protected HistoricProcessInstanceQuery	query
protected Date	removalTime
protected boolean	updateInChunks

Constructor Summary

Constructors

Constructor	Description
SetRemovalTimeToHistoricProcessInstancesBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
SetRemovalTimeToHistoricProcessInstancesBuilder	absoluteRemovalTime(Date removalTime)	Sets the removal time to an absolute date.
SetRemovalTimeToHistoricProcessInstancesBuilder	byIds(String... ids)	Selects historic decision instances by the given ids.
SetRemovalTimeToHistoricProcessInstancesBuilder	byQuery(HistoricProcessInstanceQuery query)	Selects historic process instances by the given query.
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	chunkSize(int chunkSize)	Defines the size of the chunks in which removal time updates are processed.
SetRemovalTimeToHistoricProcessInstancesBuilder	clearedRemovalTime()	Sets the removal time to null.
Batch	executeAsync()	Sets the removal time asynchronously as batch.
Integer	getChunkSize()
List<String>	getIds()
SetRemovalTimeToHistoricProcessInstancesBuilderImpl.Mode	getMode()
HistoricProcessInstanceQuery	getQuery()
Date	getRemovalTime()
SetRemovalTimeToHistoricProcessInstancesBuilder	hierarchical()	Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance.
boolean	isHierarchical()
boolean	isUpdateInChunks()
SetRemovalTimeToHistoricProcessInstancesBuilder	updateInChunks()	Handles removal time updates in chunks, taking into account the defined size in removalTimeUpdateChunkSize in the process engine configuration.

Methods inherited from class java.lang.Object

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

Field Details

query

protected HistoricProcessInstanceQuery query

ids

protected List<String> ids

removalTime

protected Date removalTime

mode

protected SetRemovalTimeToHistoricProcessInstancesBuilderImpl.Mode mode

isHierarchical

protected boolean isHierarchical

updateInChunks

protected boolean updateInChunks

chunkSize

protected Integer chunkSize

commandExecutor

protected CommandExecutor commandExecutor

Constructor Details

SetRemovalTimeToHistoricProcessInstancesBuilderImpl

public SetRemovalTimeToHistoricProcessInstancesBuilderImpl(CommandExecutor commandExecutor)

Method Details

byQuery

public SetRemovalTimeToHistoricProcessInstancesBuilder byQuery(HistoricProcessInstanceQuery query)

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

Selects historic process instances by the given query.

Specified by:

byQuery in interface SetRemovalTimeToHistoricProcessInstancesBuilder

Parameters:

query - to be evaluated.

Returns:

the builder.

byIds

public SetRemovalTimeToHistoricProcessInstancesBuilder byIds(String... ids)

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

Selects historic decision instances by the given ids.

Specified by:

byIds in interface SetRemovalTimeToHistoricProcessInstancesBuilder

Parameters:

ids - supposed to be affected.

Returns:

the builder.

absoluteRemovalTime

public SetRemovalTimeToHistoricProcessInstancesBuilder absoluteRemovalTime(Date removalTime)

Description copied from interface: SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Sets the removal time to an absolute date.

Specified by:

absoluteRemovalTime in interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

public SetRemovalTimeToHistoricProcessInstancesBuilder calculatedRemovalTime()

Description copied from interface: SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

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.

Specified by:

calculatedRemovalTime in interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Returns:

the builder.

clearedRemovalTime

public SetRemovalTimeToHistoricProcessInstancesBuilder clearedRemovalTime()

Description copied from interface: SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Sets the removal time to null.

Specified by:

clearedRemovalTime in interface SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder

Returns:

the builder.

hierarchical

public SetRemovalTimeToHistoricProcessInstancesBuilder hierarchical()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

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 SetRemovalTimeToHistoricProcessInstancesBuilder

Returns:

the builder.

updateInChunks

public SetRemovalTimeToHistoricProcessInstancesBuilder updateInChunks()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

Handles removal time updates in chunks, taking into account the defined size in removalTimeUpdateChunkSize in the process engine configuration. The size of the chunks can also be overridden per call with the SetRemovalTimeToHistoricProcessInstancesBuilder.chunkSize(int) option. Enabling this option can lead to multiple executions of the resulting jobs, preventing the database transaction from timing out by limiting the number of rows to update.

Specified by:

updateInChunks in interface SetRemovalTimeToHistoricProcessInstancesBuilder

Returns:

the builder.

chunkSize

public SetRemovalTimeToHistoricProcessInstancesBuilder chunkSize(int chunkSize)

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

Defines the size of the chunks in which removal time updates are processed. The value must be a positive integer value that doesn't exceed the ProcessSetRemovalTimeJobHandler.MAX_CHUNK_SIZE. Only has an effect if SetRemovalTimeToHistoricProcessInstancesBuilder.updateInChunks() is invoked as well. If undefined, the operation uses the `removalTimeUpdateChunkSize` defined in the process engine configuration.

Specified by:

chunkSize in interface SetRemovalTimeToHistoricProcessInstancesBuilder

Returns:

the builder.

executeAsync

public Batch executeAsync()

Description copied from interface: SetRemovalTimeToHistoricProcessInstancesBuilder

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 SetRemovalTimeToHistoricProcessInstancesBuilder

Returns:

the batch which sets the removal time asynchronously.

getQuery

public HistoricProcessInstanceQuery getQuery()

getIds

public List<String> getIds()

getRemovalTime

public Date getRemovalTime()

getMode

public SetRemovalTimeToHistoricProcessInstancesBuilderImpl.Mode getMode()

isHierarchical

public boolean isHierarchical()

isUpdateInChunks

public boolean isUpdateInChunks()

getChunkSize

public Integer getChunkSize()