org.camunda.bpm.engine.history

Interface SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

All Known Implementing Classes:

SetRemovalTimeToHistoricProcessInstancesAsyncBuilderImpl

public interface SetRemovalTimeToHistoricProcessInstancesAsyncBuilder

Fluent builder to set the removal time to historic process instances and all associated historic entities asynchronously.

Author:

Tassilo Weidner

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 historicProcessInstanceQuery) 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.
SetRemovalTimeToHistoricProcessInstancesAsyncBuilder	hierarchical() Takes additionally those historic process instances into account that are part of the hierarchy of the given historic process instance.

Method Detail

byQuery

SetRemovalTimeToHistoricProcessInstancesAsyncBuilder byQuery(HistoricProcessInstanceQuery historicProcessInstanceQuery)

Selects historic process instances by the given query.

Parameters:

historicProcessInstanceQuery - to be evaluated.

Returns:

the builder.

absoluteRemovalTime

SetRemovalTimeToHistoricProcessInstancesAsyncBuilder absoluteRemovalTime(Date removalTime)

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

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

SetRemovalTimeToHistoricProcessInstancesAsyncBuilder calculatedRemovalTime()

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

Returns:

the builder.

hierarchical

SetRemovalTimeToHistoricProcessInstancesAsyncBuilder hierarchical()

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.

Returns:

the builder.

executeAsync

Batch executeAsync()

Sets the removal time asynchronously as batch. The returned batch can be used to track the progress of setting a removal time.

Returns:

the batch which sets the removal time asynchronously.

Throws:

BadUserRequestException - when no historic process instances could be found.