Package org.camunda.bpm.engine.impl.history

Class SetRemovalTimeToHistoricBatchesBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.history.SetRemovalTimeToHistoricBatchesBuilderImpl

All Implemented Interfaces:

SetRemovalTimeSelectModeForHistoricBatchesBuilder, SetRemovalTimeToHistoricBatchesBuilder

public class SetRemovalTimeToHistoricBatchesBuilderImpl
extends Object
implements SetRemovalTimeSelectModeForHistoricBatchesBuilder

Author:

Tassilo Weidner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SetRemovalTimeToHistoricBatchesBuilderImpl.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected List<String>	ids
protected SetRemovalTimeToHistoricBatchesBuilderImpl.Mode	mode
protected HistoricBatchQuery	query
protected Date	removalTime

Constructor Summary

Constructors

Constructor	Description
SetRemovalTimeToHistoricBatchesBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
SetRemovalTimeToHistoricBatchesBuilder	absoluteRemovalTime(Date removalTime)	Sets the removal time to an absolute date.
SetRemovalTimeToHistoricBatchesBuilder	byIds(String... ids)	Selects historic batches by the given ids.
SetRemovalTimeToHistoricBatchesBuilder	byQuery(HistoricBatchQuery query)	Selects historic batches by the given query.
SetRemovalTimeToHistoricBatchesBuilder	calculatedRemovalTime()	Calculates the removal time dynamically based on the time to live of the respective batch and the engine's removal time strategy.
SetRemovalTimeToHistoricBatchesBuilder	clearedRemovalTime()	Sets the removal time to null.
Batch	executeAsync()	Sets the removal time asynchronously as batch.
List<String>	getIds()
SetRemovalTimeToHistoricBatchesBuilderImpl.Mode	getMode()
HistoricBatchQuery	getQuery()
Date	getRemovalTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

query

protected HistoricBatchQuery query

ids

protected List<String> ids

mode

protected SetRemovalTimeToHistoricBatchesBuilderImpl.Mode mode

removalTime

protected Date removalTime

commandExecutor

protected CommandExecutor commandExecutor

Constructor Details

SetRemovalTimeToHistoricBatchesBuilderImpl

public SetRemovalTimeToHistoricBatchesBuilderImpl(CommandExecutor commandExecutor)

Method Details

byQuery

public SetRemovalTimeToHistoricBatchesBuilder byQuery(HistoricBatchQuery query)

Description copied from interface: SetRemovalTimeToHistoricBatchesBuilder

Selects historic batches by the given query.

Specified by:

byQuery in interface SetRemovalTimeToHistoricBatchesBuilder

Parameters:

query - to be evaluated.

Returns:

the builder.

byIds

public SetRemovalTimeToHistoricBatchesBuilder byIds(String... ids)

Description copied from interface: SetRemovalTimeToHistoricBatchesBuilder

Selects historic batches by the given ids.

Specified by:

byIds in interface SetRemovalTimeToHistoricBatchesBuilder

Parameters:

ids - supposed to be affected.

Returns:

the builder.

absoluteRemovalTime

public SetRemovalTimeToHistoricBatchesBuilder absoluteRemovalTime(Date removalTime)

Description copied from interface: SetRemovalTimeSelectModeForHistoricBatchesBuilder

Sets the removal time to an absolute date.

Specified by:

absoluteRemovalTime in interface SetRemovalTimeSelectModeForHistoricBatchesBuilder

Parameters:

removalTime - supposed to be set to historic entities.

Returns:

the builder.

calculatedRemovalTime

public SetRemovalTimeToHistoricBatchesBuilder calculatedRemovalTime()

Description copied from interface: SetRemovalTimeSelectModeForHistoricBatchesBuilder

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

Specified by:

calculatedRemovalTime in interface SetRemovalTimeSelectModeForHistoricBatchesBuilder

Returns:

the builder.

clearedRemovalTime

public SetRemovalTimeToHistoricBatchesBuilder clearedRemovalTime()

Description copied from interface: SetRemovalTimeSelectModeForHistoricBatchesBuilder

Sets the removal time to null.

Specified by:

clearedRemovalTime in interface SetRemovalTimeSelectModeForHistoricBatchesBuilder

Returns:

the builder.

executeAsync

public Batch executeAsync()

Description copied from interface: SetRemovalTimeToHistoricBatchesBuilder

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

Specified by:

executeAsync in interface SetRemovalTimeToHistoricBatchesBuilder

Returns:

the batch which sets the removal time asynchronously.

getQuery

public HistoricBatchQuery getQuery()

getIds

public List<String> getIds()

getRemovalTime

public Date getRemovalTime()

getMode

public SetRemovalTimeToHistoricBatchesBuilderImpl.Mode getMode()