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

Class JobQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.runtime.JobQueryDto

public class JobQueryDto
extends AbstractQueryDto<JobQuery>

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String	activityId
protected List<ConditionQueryParameterDto>	createTimes
protected List<ConditionQueryParameterDto>	dueDates
protected String	exceptionMessage
protected Boolean	executable
protected String	executionId
protected String	failedActivityId
protected Boolean	includeJobsWithoutTenantId
protected String	jobDefinitionId
protected String	jobId
protected Set<String>	jobIds
protected Boolean	messages
protected Boolean	noRetriesLeft
protected Long	priorityHigherThanOrEquals
protected Long	priorityLowerThanOrEquals
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processInstanceId
protected Set<String>	processInstanceIds
protected Boolean	suspended
protected List<String>	tenantIds
protected Boolean	timers
protected Boolean	withException
protected Boolean	withoutTenantId
protected Boolean	withRetriesLeft

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

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(JobQuery query)
protected void	applySortBy(JobQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected JobQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setCreateTimes(List<ConditionQueryParameterDto> createTimes)
void	setDueDates(List<ConditionQueryParameterDto> dueDates)
void	setExceptionMessage(String exceptionMessage)
void	setExecutable(Boolean executable)
void	setExecutionId(String executionId)
void	setFailedActivityId(String activityId)
void	setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)
void	setJobDefinitionId(String jobDefinitionId)
void	setJobId(String jobId)
void	setJobIds(Set<String> jobIds)
void	setMessages(Boolean messages)
void	setNoRetriesLeft(Boolean noRetriesLeft)
void	setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)
void	setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceId(String processInstanceId)
void	setProcessInstanceIds(Set<String> processInstanceIds)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIds)
void	setTimers(Boolean timers)
void	setWithException(Boolean withException)
void	setWithoutTenantId(Boolean withoutTenantId)
void	setWithRetriesLeft(Boolean withRetriesLeft)

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

activityId

protected String activityId

jobId

protected String jobId

jobIds

protected Set<String> jobIds

executionId

protected String executionId

processInstanceId

protected String processInstanceId

processInstanceIds

protected Set<String> processInstanceIds

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

withRetriesLeft

protected Boolean withRetriesLeft

executable

protected Boolean executable

timers

protected Boolean timers

messages

protected Boolean messages

withException

protected Boolean withException

exceptionMessage

protected String exceptionMessage

failedActivityId

protected String failedActivityId

noRetriesLeft

protected Boolean noRetriesLeft

active

protected Boolean active

suspended

protected Boolean suspended

priorityHigherThanOrEquals

protected Long priorityHigherThanOrEquals

priorityLowerThanOrEquals

protected Long priorityLowerThanOrEquals

jobDefinitionId

protected String jobDefinitionId

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

includeJobsWithoutTenantId

protected Boolean includeJobsWithoutTenantId

dueDates

protected List<ConditionQueryParameterDto> dueDates

createTimes

protected List<ConditionQueryParameterDto> createTimes

Constructor Details

JobQueryDto

public JobQueryDto()

JobQueryDto

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

Method Details

setActivityId

public void setActivityId(String activityId)

setFailedActivityId

public void setFailedActivityId(String activityId)

setJobId

public void setJobId(String jobId)

setJobIds

public void setJobIds(Set<String> jobIds)

setExecutionId

public void setExecutionId(String executionId)

setProcessInstanceId

public void setProcessInstanceId(String processInstanceId)

setProcessInstanceIds

public void setProcessInstanceIds(Set<String> processInstanceIds)

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

setWithRetriesLeft

public void setWithRetriesLeft(Boolean withRetriesLeft)

setExecutable

public void setExecutable(Boolean executable)

setTimers

public void setTimers(Boolean timers)

setWithException

public void setWithException(Boolean withException)

setMessages

public void setMessages(Boolean messages)

setExceptionMessage

public void setExceptionMessage(String exceptionMessage)

setDueDates

public void setDueDates(List<ConditionQueryParameterDto> dueDates)

setCreateTimes

public void setCreateTimes(List<ConditionQueryParameterDto> createTimes)

setNoRetriesLeft

public void setNoRetriesLeft(Boolean noRetriesLeft)

setActive

public void setActive(Boolean active)

setSuspended

public void setSuspended(Boolean suspended)

setPriorityHigherThanOrEquals

public void setPriorityHigherThanOrEquals(Long priorityHigherThanOrEquals)

setPriorityLowerThanOrEquals

public void setPriorityLowerThanOrEquals(Long priorityLowerThanOrEquals)

setJobDefinitionId

public void setJobDefinitionId(String jobDefinitionId)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setIncludeJobsWithoutTenantId

public void setIncludeJobsWithoutTenantId(Boolean includeJobsWithoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<JobQuery>

createNewQuery

protected JobQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<JobQuery>

applyFilters

protected void applyFilters(JobQuery query)

Specified by:

applyFilters in class AbstractQueryDto<JobQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<JobQuery>