|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.camunda.bpm.engine.impl.db.ListQueryParameterObject
org.camunda.bpm.engine.impl.AbstractQuery<T,U>
org.camunda.bpm.engine.impl.AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
org.camunda.bpm.engine.impl.HistoricProcessInstanceQueryImpl
public class HistoricProcessInstanceQueryImpl
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
AbstractQuery.ResultType |
| Fields inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl |
|---|
queryVariableValues |
| Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
commandExecutor, expressions, orderingProperties, resultType, SORTORDER_ASC, SORTORDER_DESC, validators |
| Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject |
|---|
authCheck, databaseType, DEFAULT_ORDER_BY, firstResult, maxResults, orderBy, parameter, tenantCheck |
| Constructor Summary | |
|---|---|
HistoricProcessInstanceQueryImpl()
|
|
HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)
|
|
| Method Summary | |
|---|---|
HistoricProcessInstanceQuery |
caseInstanceId(String caseInstanceId)
Only select historic process instances which are associated with the given case instance id. |
long |
executeCount(CommandContext commandContext)
|
List<HistoricProcessInstance> |
executeList(CommandContext commandContext,
Page page)
Executes the actual query to retrieve the list of results. |
HistoricProcessInstanceQuery |
finishDateBy(Date date)
Deprecated. |
HistoricProcessInstanceQuery |
finishDateOn(Date date)
Deprecated. |
HistoricProcessInstanceQuery |
finished()
Only select historic process instances that are completely finished. |
HistoricProcessInstanceQuery |
finishedAfter(Date date)
Only select historic process instances that were started after the given date. |
HistoricProcessInstanceQuery |
finishedBefore(Date date)
Only select historic process instances that were started before the given date. |
String |
getBusinessKey()
|
String |
getBusinessKeyLike()
|
String |
getCaseInstanceId()
|
Date |
getFinishedAfter()
|
Date |
getFinishedBefore()
|
String |
getIncidentMessage()
|
String |
getIncidentMessageLike()
|
String |
getProcessDefinitionId()
|
String |
getProcessDefinitionIdLike()
|
String |
getProcessDefinitionKey()
|
String |
getProcessDefinitionName()
|
String |
getProcessDefinitionNameLike()
|
String |
getProcessInstanceId()
|
Set<String> |
getProcessInstanceIds()
|
List<String> |
getProcessKeyNotIn()
|
Date |
getStartedAfter()
|
Date |
getStartedBefore()
|
String |
getStartedBy()
|
String |
getSubCaseInstanceId()
|
String |
getSubProcessInstanceId()
|
String |
getSuperCaseInstanceId()
|
String |
getSuperProcessInstanceId()
|
protected boolean |
hasExcludingConditions()
Whether or not the query has excluding conditions. |
HistoricProcessInstanceQuery |
incidentMessage(String incidentMessage)
Only select historic process instances with the given incident message. |
HistoricProcessInstanceQuery |
incidentMessageLike(String incidentMessageLike)
Only select historic process instances which had an incident message like the given value. |
boolean |
isOpen()
|
HistoricProcessInstanceQuery |
orderByProcessDefinitionId()
Order by the process definition id (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByProcessInstanceBusinessKey()
Order by the business key (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByProcessInstanceDuration()
Order by the duration of the process instance (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByProcessInstanceEndTime()
Order by the end time (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByProcessInstanceId()
Order by the process instance id (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByProcessInstanceStartTime()
Order by the start time (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQuery |
orderByTenantId()
Order by tenant id (needs to be followed by Query.asc() or Query.desc()). |
HistoricProcessInstanceQueryImpl |
processDefinitionId(String processDefinitionId)
Only select historic process instances for the given process definition |
HistoricProcessInstanceQuery |
processDefinitionKey(String processDefinitionKey)
Only select historic process instances that are defined by a process definition with the given key. |
HistoricProcessInstanceQuery |
processDefinitionKeyNotIn(List<String> processDefinitionKeys)
Only select historic process instances that don't have a process-definition of which the key is present in the given list |
HistoricProcessInstanceQuery |
processDefinitionName(String processDefinitionName)
Only select historic process instances that are defined by a process definition with the given name. |
HistoricProcessInstanceQuery |
processDefinitionNameLike(String nameLike)
Only select historic process instances that are defined by process definition which name is like the given value. |
HistoricProcessInstanceQuery |
processInstanceBusinessKey(String businessKey)
Only select historic process instances with the given business key |
HistoricProcessInstanceQuery |
processInstanceBusinessKeyLike(String businessKeyLike)
Only select historic process instances which had a business key like the given value. |
HistoricProcessInstanceQueryImpl |
processInstanceId(String processInstanceId)
Only select historic process instances with the given process instance. |
HistoricProcessInstanceQuery |
processInstanceIds(Set<String> processInstanceIds)
Only select historic process instances whose id is in the given set of ids. |
void |
setSuperProcessInstanceId(String superProcessInstanceId)
|
HistoricProcessInstanceQuery |
startDateBy(Date date)
Deprecated. |
HistoricProcessInstanceQuery |
startDateOn(Date date)
Deprecated. |
HistoricProcessInstanceQuery |
startedAfter(Date date)
Only select historic process instances that were started after the given date. |
HistoricProcessInstanceQuery |
startedBefore(Date date)
Only select historic process instances that were started before the given date. |
HistoricProcessInstanceQuery |
startedBy(String userId)
Only select historic process instance that are started by the given user. |
HistoricProcessInstanceQuery |
subCaseInstanceId(String subCaseInstanceId)
Only select historic process instances having a sub case instance with the given case instance id. |
HistoricProcessInstanceQuery |
subProcessInstanceId(String subProcessInstanceId)
Only select historic process instances having a sub process instance with the given process instance id. |
HistoricProcessInstanceQuery |
superCaseInstanceId(String superCaseInstanceId)
Only select historic process instances started by the given case instance. |
HistoricProcessInstanceQuery |
superProcessInstanceId(String superProcessInstanceId)
Only select historic process instances started by the given process instance. |
HistoricProcessInstanceQuery |
tenantIdIn(String... tenantIds)
Only select historic process instances with one of the given tenant ids. |
HistoricProcessInstanceQuery |
unfinished()
Only select historic process instance that are not yet finished. |
HistoricProcessInstanceQuery |
withIncidents()
Only select historic process instances with incidents |
| Methods inherited from class org.camunda.bpm.engine.impl.AbstractVariableQueryImpl |
|---|
addVariable, ensureVariablesInitialized, getQueryVariableValues, variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals |
| Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery |
|---|
addExpression, addValidator, asc, checkQueryOk, count, desc, direction, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteList, execute, executeSingleResult, extend, getExpressions, getMethod, getOrderBy, getOrderingProperties, list, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, setOrderingProperties, singleResult, validate, validate |
| Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject |
|---|
getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderBy, 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.history.HistoricProcessInstanceQuery |
|---|
variableValueEquals, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThanOrEqual, variableValueLike, variableValueNotEquals |
| Methods inherited from interface org.camunda.bpm.engine.query.Query |
|---|
asc, count, desc, list, listPage, singleResult |
| Field Detail |
|---|
protected String processInstanceId
protected String processDefinitionId
protected String processDefinitionName
protected String processDefinitionNameLike
protected String businessKey
protected String businessKeyLike
protected boolean finished
protected boolean unfinished
protected boolean withIncidents
protected String incidentMessage
protected String incidentMessageLike
protected String startedBy
protected String superProcessInstanceId
protected String subProcessInstanceId
protected String superCaseInstanceId
protected String subCaseInstanceId
protected List<String> processKeyNotIn
protected Date startedBefore
protected Date startedAfter
protected Date finishedBefore
protected Date finishedAfter
protected String processDefinitionKey
protected Set<String> processInstanceIds
protected String[] tenantIds
protected String caseInstanceId
protected Date startDateBy
protected Date startDateOn
protected Date finishDateBy
protected Date finishDateOn
protected Date startDateOnBegin
protected Date startDateOnEnd
protected Date finishDateOnBegin
protected Date finishDateOnEnd
| Constructor Detail |
|---|
public HistoricProcessInstanceQueryImpl()
public HistoricProcessInstanceQueryImpl(CommandExecutor commandExecutor)
| Method Detail |
|---|
public HistoricProcessInstanceQueryImpl processInstanceId(String processInstanceId)
HistoricProcessInstanceQuery
processInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processInstanceIds(Set<String> processInstanceIds)
HistoricProcessInstanceQuery
processInstanceIds in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQueryImpl processDefinitionId(String processDefinitionId)
HistoricProcessInstanceQuery
processDefinitionId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processDefinitionKey(String processDefinitionKey)
HistoricProcessInstanceQuery
processDefinitionKey in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processDefinitionName(String processDefinitionName)
HistoricProcessInstanceQuery
processDefinitionName in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processDefinitionNameLike(String nameLike)
HistoricProcessInstanceQuery
processDefinitionNameLike in interface HistoricProcessInstanceQuerynameLike - The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).public HistoricProcessInstanceQuery processInstanceBusinessKey(String businessKey)
HistoricProcessInstanceQuery
processInstanceBusinessKey in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processInstanceBusinessKeyLike(String businessKeyLike)
HistoricProcessInstanceQuery
processInstanceBusinessKeyLike in interface HistoricProcessInstanceQuerybusinessKeyLike - The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).public HistoricProcessInstanceQuery finished()
HistoricProcessInstanceQuery
finished in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery unfinished()
HistoricProcessInstanceQuery
unfinished in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery withIncidents()
HistoricProcessInstanceQuery
withIncidents in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery incidentMessage(String incidentMessage)
HistoricProcessInstanceQuery
incidentMessage in interface HistoricProcessInstanceQueryincidentMessage - Incidents Message for which the historic process instances should be selected
public HistoricProcessInstanceQuery incidentMessageLike(String incidentMessageLike)
HistoricProcessInstanceQuery
incidentMessageLike in interface HistoricProcessInstanceQueryincidentMessageLike - The string can include the wildcard character '%' to express
like-strategy: starts with (string%), ends with (%string) or contains (%string%).
public HistoricProcessInstanceQuery startedBy(String userId)
HistoricProcessInstanceQuery
startedBy in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery processDefinitionKeyNotIn(List<String> processDefinitionKeys)
HistoricProcessInstanceQuery
processDefinitionKeyNotIn in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery startedAfter(Date date)
HistoricProcessInstanceQuery
startedAfter in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery startedBefore(Date date)
HistoricProcessInstanceQuery
startedBefore in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery finishedAfter(Date date)
HistoricProcessInstanceQuery
finishedAfter in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery finishedBefore(Date date)
HistoricProcessInstanceQuery
finishedBefore in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery superProcessInstanceId(String superProcessInstanceId)
HistoricProcessInstanceQuery
superProcessInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery subProcessInstanceId(String subProcessInstanceId)
HistoricProcessInstanceQuery
subProcessInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery superCaseInstanceId(String superCaseInstanceId)
HistoricProcessInstanceQuery
superCaseInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery subCaseInstanceId(String subCaseInstanceId)
HistoricProcessInstanceQuery
subCaseInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery caseInstanceId(String caseInstanceId)
HistoricProcessInstanceQuery
caseInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery tenantIdIn(String... tenantIds)
HistoricProcessInstanceQuery
tenantIdIn in interface HistoricProcessInstanceQueryprotected boolean hasExcludingConditions()
AbstractQuery
hasExcludingConditions in class AbstractQuery<HistoricProcessInstanceQuery,HistoricProcessInstance>true if the query does have excluding conditions, false otherwisepublic HistoricProcessInstanceQuery orderByProcessInstanceBusinessKey()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessInstanceBusinessKey in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByProcessInstanceDuration()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessInstanceDuration in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByProcessInstanceStartTime()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessInstanceStartTime in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByProcessInstanceEndTime()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessInstanceEndTime in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByProcessDefinitionId()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessDefinitionId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByProcessInstanceId()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
orderByProcessInstanceId in interface HistoricProcessInstanceQuerypublic HistoricProcessInstanceQuery orderByTenantId()
HistoricProcessInstanceQueryQuery.asc() or Query.desc()).
Note that the ordering of historic process instances without tenant id is database-specific.
orderByTenantId in interface HistoricProcessInstanceQuerypublic long executeCount(CommandContext commandContext)
executeCount in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>
public List<HistoricProcessInstance> executeList(CommandContext commandContext,
Page page)
AbstractQuery
executeList in class AbstractVariableQueryImpl<HistoricProcessInstanceQuery,HistoricProcessInstance>page - used if the results must be paged. If null, no paging will be applied.public String getBusinessKey()
public String getBusinessKeyLike()
public boolean isOpen()
public String getProcessDefinitionId()
public String getProcessDefinitionKey()
public String getProcessDefinitionIdLike()
public String getProcessDefinitionName()
public String getProcessDefinitionNameLike()
public String getProcessInstanceId()
public Set<String> getProcessInstanceIds()
public String getStartedBy()
public String getSuperProcessInstanceId()
public void setSuperProcessInstanceId(String superProcessInstanceId)
public List<String> getProcessKeyNotIn()
public Date getStartedAfter()
public Date getStartedBefore()
public Date getFinishedAfter()
public Date getFinishedBefore()
public String getCaseInstanceId()
public String getIncidentMessage()
public String getIncidentMessageLike()
@Deprecated public HistoricProcessInstanceQuery startDateBy(Date date)
HistoricProcessInstanceQuery
startDateBy in interface HistoricProcessInstanceQuery@Deprecated public HistoricProcessInstanceQuery startDateOn(Date date)
HistoricProcessInstanceQuery
startDateOn in interface HistoricProcessInstanceQuery@Deprecated public HistoricProcessInstanceQuery finishDateBy(Date date)
HistoricProcessInstanceQuery
finishDateBy in interface HistoricProcessInstanceQuery@Deprecated public HistoricProcessInstanceQuery finishDateOn(Date date)
HistoricProcessInstanceQuery
finishDateOn in interface HistoricProcessInstanceQuerypublic String getSubProcessInstanceId()
public String getSuperCaseInstanceId()
public String getSubCaseInstanceId()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||