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 java.lang.Boolean	active
protected java.lang.String	activityId
protected java.util.List<ConditionQueryParameterDto>	createTimes
protected java.util.List<ConditionQueryParameterDto>	dueDates
protected java.lang.String	exceptionMessage
protected java.lang.Boolean	executable
protected java.lang.String	executionId
protected java.lang.String	failedActivityId
protected java.lang.Boolean	includeJobsWithoutTenantId
protected java.lang.String	jobDefinitionId
protected java.lang.String	jobId
protected java.util.Set<java.lang.String>	jobIds
protected java.lang.Boolean	messages
protected java.lang.Boolean	noRetriesLeft
protected java.lang.Long	priorityHigherThanOrEquals
protected java.lang.Long	priorityLowerThanOrEquals
protected java.lang.String	processDefinitionId
protected java.lang.String	processDefinitionKey
protected java.lang.String	processInstanceId
protected java.util.Set<java.lang.String>	processInstanceIds
protected java.lang.Boolean	suspended
protected java.util.List<java.lang.String>	tenantIds
protected java.lang.Boolean	timers
protected java.lang.Boolean	withException
protected java.lang.Boolean	withoutTenantId
protected java.lang.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, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> queryParameters)

Method Summary

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

activityId

protected java.lang.String activityId

jobId

protected java.lang.String jobId

jobIds

protected java.util.Set<java.lang.String> jobIds

executionId

protected java.lang.String executionId

processInstanceId

protected java.lang.String processInstanceId

processInstanceIds

protected java.util.Set<java.lang.String> processInstanceIds

processDefinitionId

protected java.lang.String processDefinitionId

processDefinitionKey

protected java.lang.String processDefinitionKey

withRetriesLeft

protected java.lang.Boolean withRetriesLeft

executable

protected java.lang.Boolean executable

timers

protected java.lang.Boolean timers

messages

protected java.lang.Boolean messages

withException

protected java.lang.Boolean withException

exceptionMessage

protected java.lang.String exceptionMessage

failedActivityId

protected java.lang.String failedActivityId

noRetriesLeft

protected java.lang.Boolean noRetriesLeft

active

protected java.lang.Boolean active

suspended

protected java.lang.Boolean suspended

priorityHigherThanOrEquals

protected java.lang.Long priorityHigherThanOrEquals

priorityLowerThanOrEquals

protected java.lang.Long priorityLowerThanOrEquals

jobDefinitionId

protected java.lang.String jobDefinitionId

tenantIds

protected java.util.List<java.lang.String> tenantIds

withoutTenantId

protected java.lang.Boolean withoutTenantId

includeJobsWithoutTenantId

protected java.lang.Boolean includeJobsWithoutTenantId

dueDates

protected java.util.List<ConditionQueryParameterDto> dueDates

createTimes

protected java.util.List<ConditionQueryParameterDto> createTimes

Constructor Detail

JobQueryDto

public JobQueryDto()

JobQueryDto

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

Method Detail

setActivityId

public void setActivityId(java.lang.String activityId)

setFailedActivityId

public void setFailedActivityId(java.lang.String activityId)

setJobId

public void setJobId(java.lang.String jobId)

setJobIds

public void setJobIds(java.util.Set<java.lang.String> jobIds)

setExecutionId

public void setExecutionId(java.lang.String executionId)

setProcessInstanceId

public void setProcessInstanceId(java.lang.String processInstanceId)

setProcessInstanceIds

public void setProcessInstanceIds(java.util.Set<java.lang.String> processInstanceIds)

setProcessDefinitionId

public void setProcessDefinitionId(java.lang.String processDefinitionId)

setProcessDefinitionKey

public void setProcessDefinitionKey(java.lang.String processDefinitionKey)

setWithRetriesLeft

public void setWithRetriesLeft(java.lang.Boolean withRetriesLeft)

setExecutable

public void setExecutable(java.lang.Boolean executable)

setTimers

public void setTimers(java.lang.Boolean timers)

setWithException

public void setWithException(java.lang.Boolean withException)

setMessages

public void setMessages(java.lang.Boolean messages)

setExceptionMessage

public void setExceptionMessage(java.lang.String exceptionMessage)

setDueDates

public void setDueDates(java.util.List<ConditionQueryParameterDto> dueDates)

setCreateTimes

public void setCreateTimes(java.util.List<ConditionQueryParameterDto> createTimes)

setNoRetriesLeft

public void setNoRetriesLeft(java.lang.Boolean noRetriesLeft)

setActive

public void setActive(java.lang.Boolean active)

setSuspended

public void setSuspended(java.lang.Boolean suspended)

setPriorityHigherThanOrEquals

public void setPriorityHigherThanOrEquals(java.lang.Long priorityHigherThanOrEquals)

setPriorityLowerThanOrEquals

public void setPriorityLowerThanOrEquals(java.lang.Long priorityLowerThanOrEquals)

setJobDefinitionId

public void setJobDefinitionId(java.lang.String jobDefinitionId)

setTenantIdIn

public void setTenantIdIn(java.util.List<java.lang.String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(java.lang.Boolean withoutTenantId)

setIncludeJobsWithoutTenantId

public void setIncludeJobsWithoutTenantId(java.lang.Boolean includeJobsWithoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(java.lang.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,
                           java.lang.String sortBy,
                           java.util.Map<java.lang.String,java.lang.Object> parameters,
                           ProcessEngine engine)

Specified by:

applySortBy in class AbstractQueryDto<JobQuery>