SetRemovalTimeToHistoricBatchesBuilder (Camunda Platform Javadocs 7.19.0-SNAPSHOT)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SetRemovalTimeToHistoricBatchesBuilder`	`byIds(String... historicBatchIds)`	Selects historic batches by the given ids.
`SetRemovalTimeToHistoricBatchesBuilder`	`byQuery(HistoricBatchQuery historicBatchQuery)`	Selects historic batches by the given query.
`Batch`	`executeAsync()`	Sets the removal time asynchronously as batch.

- Method Detail
  - byQuery
```
SetRemovalTimeToHistoricBatchesBuilder byQuery(HistoricBatchQuery historicBatchQuery)
```
    Selects historic batches by the given query.
    
    Parameters:
    
    historicBatchQuery - to be evaluated.
    
    Returns:
    
    the builder.
  - byIds
```
SetRemovalTimeToHistoricBatchesBuilder byIds(String... historicBatchIds)
```
    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 no CREATE_BATCH_SET_REMOVAL_TIME or no permission CREATE permission is granted on Resources.BATCH.