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

Class JobDefinitionQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.management.JobDefinitionQueryDto

public class JobDefinitionQueryDto
extends AbstractQueryDto<JobDefinitionQuery>

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String[]	activityIdIn
protected Boolean	includeJobDefinitionsWithoutTenantId
protected String	jobConfiguration
protected String	jobDefinitionId
protected String	jobType
protected String	processDefinitionId
protected String	processDefinitionKey
protected Boolean	suspended
protected List<String>	tenantIds
protected Boolean	withoutTenantId
protected Boolean	withOverridingJobPriority

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

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(JobDefinitionQuery query)
protected void	applySortBy(JobDefinitionQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected JobDefinitionQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setActivityIdIn(String[] activityIdIn)
void	setIncludeJobDefinitionsWithoutTenantId(Boolean includeJobDefinitionsWithoutTenantId)
void	setJobConfiguration(String jobConfiguration)
void	setJobDefinitionId(String jobDefinitionId)
void	setJobType(String jobType)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIds)
void	setWithoutTenantId(Boolean withoutTenantId)
void	setWithOverridingJobPriority(Boolean withOverridingJobPriority)

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

jobDefinitionId

protected String jobDefinitionId

activityIdIn

protected String[] activityIdIn

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

jobType

protected String jobType

jobConfiguration

protected String jobConfiguration

active

protected Boolean active

suspended

protected Boolean suspended

withOverridingJobPriority

protected Boolean withOverridingJobPriority

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

includeJobDefinitionsWithoutTenantId

protected Boolean includeJobDefinitionsWithoutTenantId

Constructor Details

JobDefinitionQueryDto

public JobDefinitionQueryDto()

JobDefinitionQueryDto

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

Method Details

setJobDefinitionId

public void setJobDefinitionId(String jobDefinitionId)

setActivityIdIn

public void setActivityIdIn(String[] activityIdIn)

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

setJobType

public void setJobType(String jobType)

setJobConfiguration

public void setJobConfiguration(String jobConfiguration)

setActive

public void setActive(Boolean active)

setSuspended

public void setSuspended(Boolean suspended)

setWithOverridingJobPriority

public void setWithOverridingJobPriority(Boolean withOverridingJobPriority)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setIncludeJobDefinitionsWithoutTenantId

public void setIncludeJobDefinitionsWithoutTenantId(Boolean includeJobDefinitionsWithoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<JobDefinitionQuery>

createNewQuery

protected JobDefinitionQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<JobDefinitionQuery>

applyFilters

protected void applyFilters(JobDefinitionQuery query)

Specified by:

applyFilters in class AbstractQueryDto<JobDefinitionQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<JobDefinitionQuery>