Package org.camunda.bpm.engine.history
Interface SetRemovalTimeToHistoricBatchesBuilder
- All Known Subinterfaces:
SetRemovalTimeSelectModeForHistoricBatchesBuilder
- All Known Implementing Classes:
SetRemovalTimeToHistoricBatchesBuilderImpl
public interface SetRemovalTimeToHistoricBatchesBuilder
Fluent builder to set the removal time to historic batches and
all associated historic entities.
- Author:
- Tassilo Weidner
-
Method Summary
Modifier and TypeMethodDescriptionSelects historic batches by the given ids.byQuery
(HistoricBatchQuery historicBatchQuery) Selects historic batches by the given query.Sets the removal time asynchronously as batch.
-
Method Details
-
byQuery
Selects historic batches by the given query.- Parameters:
historicBatchQuery
- to be evaluated.- Returns:
- the builder.
-
byIds
Selects historic batches by the given ids.- Parameters:
historicBatchIds
- supposed to be affected.- 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 batches could be found.AuthorizationException
- when noCREATE_BATCH_SET_REMOVAL_TIME
or no permissionCREATE
permission is granted onResources.BATCH
.
-