org.camunda.bpm.engine.history

Interface CleanableHistoricCaseInstanceReport

All Superinterfaces:

Query<CleanableHistoricCaseInstanceReport,CleanableHistoricCaseInstanceReportResult>

All Known Implementing Classes:

CleanableHistoricCaseInstanceReportImpl

public interface CleanableHistoricCaseInstanceReport
extends Query<CleanableHistoricCaseInstanceReport,CleanableHistoricCaseInstanceReportResult>

Defines a report query for cleanable case instances.

Method Summary

Modifier and Type	Method and Description
CleanableHistoricCaseInstanceReport	caseDefinitionIdIn(String... caseDefinitionIds) Only takes historic case instances into account for the given case definition ids.
CleanableHistoricCaseInstanceReport	caseDefinitionKeyIn(String... caseDefinitionKeys) Only takes historic case instances into account for the given case definition keys.
CleanableHistoricCaseInstanceReport	compact() Only selects historic case instances which have more than zero finished instances.
CleanableHistoricCaseInstanceReport	orderByFinished() Order by finished case instances amount (needs to be followed by Query.asc() or Query.desc()).
CleanableHistoricCaseInstanceReport	tenantIdIn(String... tenantIds) Only select historic case instances with one of the given tenant ids.
CleanableHistoricCaseInstanceReport	withoutTenantId() Only selects historic case instances which have no tenant id.

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

asc, count, desc, list, listPage, singleResult

Method Detail

caseDefinitionIdIn

CleanableHistoricCaseInstanceReport caseDefinitionIdIn(String... caseDefinitionIds)

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

Throws:

NotValidException - if one of the given ids is null

caseDefinitionKeyIn

CleanableHistoricCaseInstanceReport caseDefinitionKeyIn(String... caseDefinitionKeys)

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

Throws:

NotValidException - if one of the given keys is null

tenantIdIn

CleanableHistoricCaseInstanceReport tenantIdIn(String... tenantIds)

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

Throws:

NotValidException - if one of the given ids is null

withoutTenantId

CleanableHistoricCaseInstanceReport withoutTenantId()

Only selects historic case instances which have no tenant id.

compact

CleanableHistoricCaseInstanceReport compact()

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

orderByFinished

CleanableHistoricCaseInstanceReport orderByFinished()

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