org.camunda.bpm.engine.history

Interface SetRemovalTimeToHistoricDecisionInstancesBuilder

All Known Subinterfaces:

SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder

All Known Implementing Classes:

SetRemovalTimeToHistoricDecisionInstancesBuilderImpl

public interface SetRemovalTimeToHistoricDecisionInstancesBuilder

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

Author:

Tassilo Weidner

Method Summary

Modifier and Type	Method and Description
SetRemovalTimeToHistoricDecisionInstancesBuilder	byIds(String... historicProcessInstanceIds) Selects historic process instances by the given ids.
SetRemovalTimeToHistoricDecisionInstancesBuilder	byQuery(HistoricDecisionInstanceQuery historicDecisionInstanceQuery) Selects historic decision instances by the given query.
Batch	executeAsync() Sets the removal time asynchronously as batch.
SetRemovalTimeToHistoricDecisionInstancesBuilder	hierarchical() Takes additionally historic decision instances into account that are part of the hierarchy of the given historic decision instances.

Method Detail

byQuery

SetRemovalTimeToHistoricDecisionInstancesBuilder byQuery(HistoricDecisionInstanceQuery historicDecisionInstanceQuery)

Selects historic decision instances by the given query.

Parameters:

historicDecisionInstanceQuery - to be evaluated.

Returns:

the builder.

byIds

SetRemovalTimeToHistoricDecisionInstancesBuilder byIds(String... historicProcessInstanceIds)

Selects historic process instances by the given ids.

Parameters:

historicProcessInstanceIds - supposed to be affected.

Returns:

the builder.

hierarchical

SetRemovalTimeToHistoricDecisionInstancesBuilder hierarchical()

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.

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 decision instances could be found.

AuthorizationException - when no CREATE_BATCH_SET_REMOVAL_TIME or no permission CREATE permission is granted on Resources.BATCH.