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

Class HistoricDetailQueryDto

java.lang.Object

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

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

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

public class HistoricDetailQueryDto
extends AbstractQueryDto<HistoricDetailQuery>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activityInstanceId
protected String	caseExecutionId
protected String	caseInstanceId
protected Boolean	excludeTaskDetails
protected String	executionId
protected Boolean	formFields
protected String	processInstanceId
protected String[]	processInstanceIdIn
protected String	taskId
protected List<String>	tenantIds
protected String	userOperationId
protected String	variableInstanceId
protected String[]	variableTypeIn
protected Boolean	variableUpdates
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 and Description
HistoricDetailQueryDto()
HistoricDetailQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method and Description
protected void	applyFilters(HistoricDetailQuery query)
protected void	applySortBy(HistoricDetailQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected HistoricDetailQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActivityInstanceId(String activityInstanceId)
void	setCaseExecutionId(String caseExecutionId)
void	setCaseInstanceId(String caseInstanceId)
void	setExcludeTaskDetails(Boolean excludeTaskDetails)
void	setExecutionId(String executionId)
void	setFormFields(Boolean formFields)
void	setOccurredAfter(Date occurredAfter)
void	setOccurredBefore(Date occurredBefore)
void	setProcessInstanceId(String processInstanceId)
void	setProcessInstanceIdIn(String[] processInstanceIdIn)
void	setTaskId(String taskId)
void	setTenantIdIn(List<String> tenantIds)
void	setUserOperationId(String userOperationId)
void	setVariableInstanceId(String variableInstanceId)
void	setVariableTypeIn(String[] variableTypeIn)
void	setVariableUpdates(Boolean variableUpdates)
void	setWithoutTenantId(Boolean withoutTenantId)
protected boolean	sortOptionsValid()

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

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, 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 Detail

processInstanceId

protected String processInstanceId

executionId

protected String executionId

activityInstanceId

protected String activityInstanceId

caseInstanceId

protected String caseInstanceId

caseExecutionId

protected String caseExecutionId

variableInstanceId

protected String variableInstanceId

variableTypeIn

protected String[] variableTypeIn

taskId

protected String taskId

formFields

protected Boolean formFields

variableUpdates

protected Boolean variableUpdates

excludeTaskDetails

protected Boolean excludeTaskDetails

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

processInstanceIdIn

protected String[] processInstanceIdIn

userOperationId

protected String userOperationId

Constructor Detail

HistoricDetailQueryDto

public HistoricDetailQueryDto()

HistoricDetailQueryDto

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

Method Detail

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

setExecutionId

public void setExecutionId(String executionId)

setActivityInstanceId

public void setActivityInstanceId(String activityInstanceId)

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

setCaseExecutionId

public void setCaseExecutionId(String caseExecutionId)

setVariableInstanceId

public void setVariableInstanceId(String variableInstanceId)

setVariableTypeIn

public void setVariableTypeIn(String[] variableTypeIn)

setTaskId

public void setTaskId(String taskId)

setFormFields

public void setFormFields(Boolean formFields)

setVariableUpdates

public void setVariableUpdates(Boolean variableUpdates)

setExcludeTaskDetails

public void setExcludeTaskDetails(Boolean excludeTaskDetails)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setProcessInstanceIdIn

public void setProcessInstanceIdIn(String[] processInstanceIdIn)

setUserOperationId

public void setUserOperationId(String userOperationId)

setOccurredBefore

public void setOccurredBefore(Date occurredBefore)

setOccurredAfter

public void setOccurredAfter(Date occurredAfter)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<HistoricDetailQuery>

createNewQuery

protected HistoricDetailQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<HistoricDetailQuery>

sortOptionsValid

protected boolean sortOptionsValid()

Overrides:

sortOptionsValid in class AbstractQueryDto<HistoricDetailQuery>

applyFilters

protected void applyFilters(HistoricDetailQuery query)

Specified by:

applyFilters in class AbstractQueryDto<HistoricDetailQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<HistoricDetailQuery>