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

Class ExternalTaskQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.externaltask.ExternalTaskQueryDto

public class ExternalTaskQueryDto
extends AbstractQueryDto<ExternalTaskQuery>

Author:

Thorben Lindhauer

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String	activityId
protected List<String>	activityIdIn
protected String	executionId
protected String	externalTaskId
protected Set<String>	externalTaskIds
protected Boolean	locked
protected Date	lockExpirationAfter
protected Date	lockExpirationBefore
protected Boolean	noRetriesLeft
protected Boolean	notLocked
protected Long	priorityHigherThanOrEquals
protected Long	priorityLowerThanOrEquals
protected String	processDefinitionId
protected String	processInstanceId
protected List<String>	processInstanceIdIn
static final String	SORT_BY_ID_VALUE
static final String	SORT_BY_LOCK_EXPIRATION_TIME
static final String	SORT_BY_PRIORITY
static final String	SORT_BY_PROCESS_DEFINITION_ID
static final String	SORT_BY_PROCESS_DEFINITION_KEY
static final String	SORT_BY_PROCESS_INSTANCE_ID
static final String	SORT_BY_TENANT_ID
protected Boolean	suspended
protected List<String>	tenantIds
protected String	topicName
static final List<String>	VALID_SORT_BY_VALUES
protected Boolean	withRetriesLeft
protected String	workerId

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
ExternalTaskQueryDto()
ExternalTaskQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(ExternalTaskQuery query)
protected void	applySortBy(ExternalTaskQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected ExternalTaskQuery	createNewQuery(ProcessEngine engine)
String	getProcessDefinitionId()
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setActivityIdIn(List<String> activityIdIn)
void	setExecutionId(String executionId)
void	setExternalTaskId(String externalTaskId)
void	setExternalTaskIdIn(Set<String> externalTaskIds)
void	setLocked(Boolean locked)
void	setLockExpirationAfter(Date lockExpirationAfter)
void	setLockExpirationBefore(Date lockExpirationBefore)
void	setNoRetriesLeft(Boolean noRetriesLeft)
void	setNotLocked(Boolean notLocked)
void	setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
void	setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceId(String processInstanceId)
void	setProcessInstanceIdIn(List<String> processInstanceIdIn)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIds)
void	setTopicName(String topicName)
void	setWithRetriesLeft(Boolean withRetriesLeft)
void	setWorkerId(String workerId)

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_ID_VALUE

public static final String SORT_BY_ID_VALUE

See Also:

• Constant Field Values

SORT_BY_LOCK_EXPIRATION_TIME

public static final String SORT_BY_LOCK_EXPIRATION_TIME

See Also:

• Constant Field Values

SORT_BY_PROCESS_INSTANCE_ID

public static final String SORT_BY_PROCESS_INSTANCE_ID

See Also:

• Constant Field Values

SORT_BY_PROCESS_DEFINITION_ID

public static final String SORT_BY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

SORT_BY_PROCESS_DEFINITION_KEY

public static final String SORT_BY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

SORT_BY_TENANT_ID

public static final String SORT_BY_TENANT_ID

See Also:

• Constant Field Values

SORT_BY_PRIORITY

public static final String SORT_BY_PRIORITY

See Also:

• Constant Field Values

VALID_SORT_BY_VALUES

public static final List<String> VALID_SORT_BY_VALUES

externalTaskId

protected String externalTaskId

externalTaskIds

protected Set<String> externalTaskIds

activityId

protected String activityId

activityIdIn

protected List<String> activityIdIn

lockExpirationBefore

protected Date lockExpirationBefore

lockExpirationAfter

protected Date lockExpirationAfter

topicName

protected String topicName

locked

protected Boolean locked

notLocked

protected Boolean notLocked

executionId

protected String executionId

processInstanceId

protected String processInstanceId

processInstanceIdIn

protected List<String> processInstanceIdIn

processDefinitionId

protected String processDefinitionId

active

protected Boolean active

suspended

protected Boolean suspended

withRetriesLeft

protected Boolean withRetriesLeft

noRetriesLeft

protected Boolean noRetriesLeft

workerId

protected String workerId

tenantIds

protected List<String> tenantIds

priorityHigherThanOrEquals

protected Long priorityHigherThanOrEquals

priorityLowerThanOrEquals

protected Long priorityLowerThanOrEquals

Constructor Details

ExternalTaskQueryDto

public ExternalTaskQueryDto()

ExternalTaskQueryDto

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

Method Details

setExternalTaskId

public void setExternalTaskId(String externalTaskId)

setExternalTaskIdIn

public void setExternalTaskIdIn(Set<String> externalTaskIds)

setActivityId

public void setActivityId(String activityId)

setActivityIdIn

public void setActivityIdIn(List<String> activityIdIn)

setLockExpirationBefore

public void setLockExpirationBefore(Date lockExpirationBefore)

setLockExpirationAfter

public void setLockExpirationAfter(Date lockExpirationAfter)

setTopicName

public void setTopicName(String topicName)

setLocked

public void setLocked(Boolean locked)

setNotLocked

public void setNotLocked(Boolean notLocked)

setExecutionId

public void setExecutionId(String executionId)

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

setProcessInstanceIdIn

public void setProcessInstanceIdIn(List<String> processInstanceIdIn)

getProcessDefinitionId

public String getProcessDefinitionId()

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setActive

public void setActive(Boolean active)

setSuspended

public void setSuspended(Boolean suspended)

setWithRetriesLeft

public void setWithRetriesLeft(Boolean withRetriesLeft)

setNoRetriesLeft

public void setNoRetriesLeft(Boolean noRetriesLeft)

setWorkerId

public void setWorkerId(String workerId)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setPriorityHigherThanOrEquals

public void setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

setPriorityLowerThanOrEquals

public void setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<ExternalTaskQuery>

createNewQuery

protected ExternalTaskQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<ExternalTaskQuery>

applyFilters

protected void applyFilters(ExternalTaskQuery query)

Specified by:

applyFilters in class AbstractQueryDto<ExternalTaskQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<ExternalTaskQuery>