Package org.camunda.bpm.engine.impl

Class CleanableHistoricProcessInstanceReportImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<CleanableHistoricProcessInstanceReport,CleanableHistoricProcessInstanceReportResult>

org.camunda.bpm.engine.impl.CleanableHistoricProcessInstanceReportImpl

All Implemented Interfaces:

Serializable, CleanableHistoricProcessInstanceReport, Command<Object>, Query<CleanableHistoricProcessInstanceReport,CleanableHistoricProcessInstanceReportResult>

public class CleanableHistoricProcessInstanceReportImpl
extends AbstractQuery<CleanableHistoricProcessInstanceReport,CleanableHistoricProcessInstanceReportResult>
implements CleanableHistoricProcessInstanceReport

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	currentTimestamp
protected boolean	isCompact
protected boolean	isHistoryCleanupStrategyRemovalTimeBased
protected boolean	isTenantIdSet
protected String[]	processDefinitionIdIn
protected String[]	processDefinitionKeyIn
protected String[]	tenantIdIn

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor	Description
CleanableHistoricProcessInstanceReportImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
CleanableHistoricProcessInstanceReport	compact()	Only selects historic process instances which have more than zero finished instances.
long	executeCount(CommandContext commandContext)
List<CleanableHistoricProcessInstanceReportResult>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
Date	getCurrentTimestamp()
String[]	getProcessDefinitionIdIn()
String[]	getProcessDefinitionKeyIn()
String[]	getTenantIdIn()
boolean	isCompact()
boolean	isHistoryCleanupStrategyRemovalTimeBased()
boolean	isTenantIdSet()
CleanableHistoricProcessInstanceReport	orderByFinished()	Order by finished process instances amount (needs to be followed by Query.asc() or Query.desc()).
CleanableHistoricProcessInstanceReport	processDefinitionIdIn(String... processDefinitionIds)	Only takes historic process instances into account for the given process definition ids.
CleanableHistoricProcessInstanceReport	processDefinitionKeyIn(String... processDefinitionKeys)	Only takes historic process instances into account for the given process definition keys.
protected void	provideHistoryCleanupStrategy(CommandContext commandContext)
void	setCurrentTimestamp(Date currentTimestamp)
void	setTenantIdIn(String[] tenantIdIn)
CleanableHistoricProcessInstanceReport	tenantIdIn(String... tenantIds)	Only select historic process instances with one of the given tenant ids.
CleanableHistoricProcessInstanceReport	withoutTenantId()	Only selects historic process instances which have no tenant id.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Details

processDefinitionIdIn

protected String[] processDefinitionIdIn

processDefinitionKeyIn

protected String[] processDefinitionKeyIn

tenantIdIn

protected String[] tenantIdIn

isTenantIdSet

protected boolean isTenantIdSet

isCompact

protected boolean isCompact

currentTimestamp

protected Date currentTimestamp

isHistoryCleanupStrategyRemovalTimeBased

protected boolean isHistoryCleanupStrategyRemovalTimeBased

Constructor Details

CleanableHistoricProcessInstanceReportImpl

public CleanableHistoricProcessInstanceReportImpl(CommandExecutor commandExecutor)

Method Details

processDefinitionIdIn

public CleanableHistoricProcessInstanceReport processDefinitionIdIn(String... processDefinitionIds)

Description copied from interface: CleanableHistoricProcessInstanceReport

Only takes historic process instances into account for the given process definition ids.

Specified by:

processDefinitionIdIn in interface CleanableHistoricProcessInstanceReport

processDefinitionKeyIn

public CleanableHistoricProcessInstanceReport processDefinitionKeyIn(String... processDefinitionKeys)

Description copied from interface: CleanableHistoricProcessInstanceReport

Only takes historic process instances into account for the given process definition keys.

Specified by:

processDefinitionKeyIn in interface CleanableHistoricProcessInstanceReport

tenantIdIn

public CleanableHistoricProcessInstanceReport tenantIdIn(String... tenantIds)

Description copied from interface: CleanableHistoricProcessInstanceReport

Only select historic process instances with one of the given tenant ids.

Specified by:

tenantIdIn in interface CleanableHistoricProcessInstanceReport

withoutTenantId

public CleanableHistoricProcessInstanceReport withoutTenantId()

Description copied from interface: CleanableHistoricProcessInstanceReport

Only selects historic process instances which have no tenant id.

Specified by:

withoutTenantId in interface CleanableHistoricProcessInstanceReport

compact

public CleanableHistoricProcessInstanceReport compact()

Description copied from interface: CleanableHistoricProcessInstanceReport

Only selects historic process instances which have more than zero finished instances.

Specified by:

compact in interface CleanableHistoricProcessInstanceReport

orderByFinished

public CleanableHistoricProcessInstanceReport orderByFinished()

Description copied from interface: CleanableHistoricProcessInstanceReport

Order by finished process instances amount (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByFinished in interface CleanableHistoricProcessInstanceReport

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<CleanableHistoricProcessInstanceReport,CleanableHistoricProcessInstanceReportResult>

executeList

public List<CleanableHistoricProcessInstanceReportResult> executeList(CommandContext commandContext,
 Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<CleanableHistoricProcessInstanceReport,CleanableHistoricProcessInstanceReportResult>

page - used if the results must be paged. If null, no paging will be applied.

getCurrentTimestamp

public Date getCurrentTimestamp()

setCurrentTimestamp

public void setCurrentTimestamp(Date currentTimestamp)

getProcessDefinitionIdIn

public String[] getProcessDefinitionIdIn()

getProcessDefinitionKeyIn

public String[] getProcessDefinitionKeyIn()

getTenantIdIn

public String[] getTenantIdIn()

setTenantIdIn

public void setTenantIdIn(String[] tenantIdIn)

isTenantIdSet

public boolean isTenantIdSet()

isCompact

public boolean isCompact()

provideHistoryCleanupStrategy

protected void provideHistoryCleanupStrategy(CommandContext commandContext)

isHistoryCleanupStrategyRemovalTimeBased

public boolean isHistoryCleanupStrategyRemovalTimeBased()