Package org.camunda.bpm.engine.rest.dto.history

Class HistoricActivityInstanceQueryDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

org.camunda.bpm.engine.rest.dto.AbstractQueryDto<HistoricActivityInstanceQuery>

org.camunda.bpm.engine.rest.dto.history.HistoricActivityInstanceQueryDto

public class HistoricActivityInstanceQueryDto
extends AbstractQueryDto<HistoricActivityInstanceQuery>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	activityId
protected String	activityInstanceId
protected String	activityName
protected String	activityNameLike
protected String	activityType
protected Boolean	canceled
protected Boolean	completeScope
protected String	executionId
protected Boolean	finished
protected Date	finishedAfter
protected Date	finishedBefore
protected String	processDefinitionId
protected String	processInstanceId
protected static final String	SORT_BY_ACTIVITY_ID_VALUE
protected static final String	SORT_BY_ACTIVITY_NAME_VALUE
protected static final String	SORT_BY_ACTIVITY_TYPE_VALUE
protected static final String	SORT_BY_EXECUTION_ID_VALUE
protected static final String	SORT_BY_HISTORIC_ACTIVITY_INSTANCE_DURATION_VALUE
protected static final String	SORT_BY_HISTORIC_ACTIVITY_INSTANCE_END_TIME_VALUE
protected static final String	SORT_BY_HISTORIC_ACTIVITY_INSTANCE_ID_VALUE
protected static final String	SORT_BY_HISTORIC_ACTIVITY_INSTANCE_START_TIME_VALUE
protected static final String	SORT_BY_PROCESS_DEFINITION_ID_VALUE
protected static final String	SORT_BY_PROCESS_INSTANCE_ID_VALUE
protected static final String	SORT_BY_TENANT_ID
protected static final String	SORT_PARTIALLY_BY_OCCURRENCE
protected Date	startedAfter
protected Date	startedBefore
protected String	taskAssignee
protected List<String>	tenantIds
protected Boolean	unfinished
protected static final List<String>	VALID_SORT_BY_VALUES
protected Boolean	withoutTenantId

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

expressions, SORT_ORDER_ASC_VALUE, SORT_ORDER_DESC_VALUE, sortBy, sortings, sortOrder, VALID_SORT_ORDER_VALUES

Fields inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

objectMapper

Constructor Summary

Constructors

Constructor	Description
HistoricActivityInstanceQueryDto()
HistoricActivityInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(HistoricActivityInstanceQuery query)
protected void	applySortBy(HistoricActivityInstanceQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected HistoricActivityInstanceQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActivityId(String activityId)
void	setActivityInstanceId(String activityInstanceId)
void	setActivityName(String activityName)
void	setActivityNameLike(String activityNameLike)
void	setActivityType(String activityType)
void	setCanceled(Boolean canceled)
void	setCompleteScope(Boolean completeScope)
void	setExecutionId(String executionId)
void	setFinished(Boolean finished)
void	setFinishedAfter(Date finishedAfter)
void	setFinishedBefore(Date finishedBefore)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceId(String processInstanceId)
void	setStartedAfter(Date startedAfter)
void	setStartedBefore(Date startedBefore)
void	setTaskAssignee(String taskAssignee)
void	setTenantIdIn(List<String> tenantIds)
void	setUnfinished(Boolean unfinished)
void	setWithoutTenantId(Boolean withoutTenantId)

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractQueryDto

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, sortOptionsValid, sortOrderValueForDirection, toQuery

Methods inherited from class org.camunda.bpm.engine.rest.dto.AbstractSearchQueryDto

setObjectMapper, setValueBasedOnAnnotation

Methods inherited from class java.lang.Object

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

Field Details

SORT_BY_HISTORIC_ACTIVITY_INSTANCE_ID_VALUE

protected static final String SORT_BY_HISTORIC_ACTIVITY_INSTANCE_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_PROCESS_INSTANCE_ID_VALUE

protected static final String SORT_BY_PROCESS_INSTANCE_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_EXECUTION_ID_VALUE

protected static final String SORT_BY_EXECUTION_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_ACTIVITY_ID_VALUE

protected static final String SORT_BY_ACTIVITY_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_ACTIVITY_NAME_VALUE

protected static final String SORT_BY_ACTIVITY_NAME_VALUE

See Also:

• Constant Field Values

SORT_BY_ACTIVITY_TYPE_VALUE

protected static final String SORT_BY_ACTIVITY_TYPE_VALUE

See Also:

• Constant Field Values

SORT_BY_HISTORIC_ACTIVITY_INSTANCE_START_TIME_VALUE

protected static final String SORT_BY_HISTORIC_ACTIVITY_INSTANCE_START_TIME_VALUE

See Also:

• Constant Field Values

SORT_BY_HISTORIC_ACTIVITY_INSTANCE_END_TIME_VALUE

protected static final String SORT_BY_HISTORIC_ACTIVITY_INSTANCE_END_TIME_VALUE

See Also:

• Constant Field Values

SORT_BY_HISTORIC_ACTIVITY_INSTANCE_DURATION_VALUE

protected static final String SORT_BY_HISTORIC_ACTIVITY_INSTANCE_DURATION_VALUE

See Also:

• Constant Field Values

SORT_BY_PROCESS_DEFINITION_ID_VALUE

protected static final String SORT_BY_PROCESS_DEFINITION_ID_VALUE

See Also:

• Constant Field Values

SORT_PARTIALLY_BY_OCCURRENCE

protected static final String SORT_PARTIALLY_BY_OCCURRENCE

See Also:

• Constant Field Values

SORT_BY_TENANT_ID

protected static final String SORT_BY_TENANT_ID

See Also:

• Constant Field Values

VALID_SORT_BY_VALUES

protected static final List<String> VALID_SORT_BY_VALUES

activityInstanceId

protected String activityInstanceId

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

executionId

protected String executionId

activityId

protected String activityId

activityName

protected String activityName

activityNameLike

protected String activityNameLike

activityType

protected String activityType

taskAssignee

protected String taskAssignee

finished

protected Boolean finished

unfinished

protected Boolean unfinished

completeScope

protected Boolean completeScope

canceled

protected Boolean canceled

startedBefore

protected Date startedBefore

startedAfter

protected Date startedAfter

finishedBefore

protected Date finishedBefore

finishedAfter

protected Date finishedAfter

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

Constructor Details

HistoricActivityInstanceQueryDto

public HistoricActivityInstanceQueryDto()

HistoricActivityInstanceQueryDto

public HistoricActivityInstanceQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Details

setActivityInstanceId

public void setActivityInstanceId(String activityInstanceId)

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setExecutionId

public void setExecutionId(String executionId)

setActivityId

public void setActivityId(String activityId)

setActivityName

public void setActivityName(String activityName)

setActivityNameLike

public void setActivityNameLike(String activityNameLike)

setActivityType

public void setActivityType(String activityType)

setTaskAssignee

public void setTaskAssignee(String taskAssignee)

setFinished

public void setFinished(Boolean finished)

setUnfinished

public void setUnfinished(Boolean unfinished)

setCompleteScope

public void setCompleteScope(Boolean completeScope)

setCanceled

public void setCanceled(Boolean canceled)

setStartedBefore

public void setStartedBefore(Date startedBefore)

setStartedAfter

public void setStartedAfter(Date startedAfter)

setFinishedBefore

public void setFinishedBefore(Date finishedBefore)

setFinishedAfter

public void setFinishedAfter(Date finishedAfter)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<HistoricActivityInstanceQuery>

createNewQuery

protected HistoricActivityInstanceQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<HistoricActivityInstanceQuery>

applyFilters

protected void applyFilters(HistoricActivityInstanceQuery query)

Specified by:

applyFilters in class AbstractQueryDto<HistoricActivityInstanceQuery>

applySortBy

protected void applySortBy(HistoricActivityInstanceQuery query,
 String sortBy,
 Map<String,Object> parameters,
 ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<HistoricActivityInstanceQuery>