org.camunda.bpm.engine.impl.history

Interface HistoryRemovalTimeProvider

All Known Implementing Classes:

DefaultHistoryRemovalTimeProvider

public interface HistoryRemovalTimeProvider

The provider is either invoked on root process instance start or end based on the selected history removal time strategy.

Author:

Tassilo Weidner

Method Summary

Modifier and Type	Method and Description
Date	calculateRemovalTime(HistoricProcessInstanceEventEntity historicRootProcessInstance, ProcessDefinition processDefinition) Calculates the removal time of historic entities.

Method Detail

calculateRemovalTime

Date calculateRemovalTime(HistoricProcessInstanceEventEntity historicRootProcessInstance,
                          ProcessDefinition processDefinition)

Calculates the removal time of historic entities. START: the removal time is set for each historic entity separately on occurrence (creation). HistoricScopeInstanceEvent.getEndTime() is null END: the removal time is updated simultaneously for all historic entities which belong to the root process instance when it ends. HistoricScopeInstanceEvent.getEndTime() is not null

Parameters:

historicRootProcessInstance - which is either in state running or ended

processDefinition - of the historic root process instance

Returns:

the removal time of historic entities