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

Class ProcessDefinitionQueryDto

java.lang.Object

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

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

org.camunda.bpm.engine.rest.dto.repository.ProcessDefinitionQueryDto

public class ProcessDefinitionQueryDto
extends AbstractQueryDto<ProcessDefinitionQuery>

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected String	category
protected String	categoryLike
protected Date	deployedAfter
protected Date	deployedAt
protected String	deploymentId
protected String	incidentId
protected String	incidentMessage
protected String	incidentMessageLike
protected String	incidentType
protected Boolean	includeDefinitionsWithoutTenantId
protected String	key
protected String	keyLike
protected List<String>	keys
protected Boolean	latestVersion
protected String	name
protected String	nameLike
protected Boolean	notStartableInTasklist
protected String	processDefinitionId
protected List<String>	processDefinitionIdIn
protected String	resourceName
protected String	resourceNameLike
protected String	startableBy
protected Boolean	startableInTasklist
protected Boolean	startablePermissionCheck
protected Boolean	suspended
protected List<String>	tenantIds
protected Integer	version
protected String	versionTag
protected String	versionTagLike
protected Boolean	withoutTenantId
protected Boolean	withoutVersionTag

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

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(ProcessDefinitionQuery query)
protected void	applySortBy(ProcessDefinitionQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected ProcessDefinitionQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setActive(Boolean active)
void	setCategory(String category)
void	setCategoryLike(String categoryLike)
void	setDeployedAfter(Date deployedAfter)
void	setDeployedAt(Date deployedAt)
void	setDeploymentId(String deploymentId)
void	setIncidentId(String incidentId)
void	setIncidentMessage(String incidentMessage)
void	setIncidentMessageLike(String incidentMessageLike)
void	setIncidentType(String incidentType)
void	setIncludeProcessDefinitionsWithoutTenantId(Boolean includeDefinitionsWithoutTenantId)
void	setKey(String key)
void	setKeyLike(String keyLike)
void	setKeysIn(List<String> keys)
void	setLatest(Boolean latest)	Deprecated. use setLatestVersion(Boolean)
void	setLatestVersion(Boolean latestVersion)
void	setName(String name)
void	setNameLike(String nameLike)
void	setNotStartableInTasklist(Boolean notStartableInTasklist)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionIdIn(List<String> processDefinitionIdIn)
void	setResourceName(String resourceName)
void	setResourceNameLike(String resourceNameLike)
void	setStartableBy(String startableBy)
void	setStartableInTasklist(Boolean startableInTasklist)
void	setStartablePermissionCheck(Boolean startablePermissionCheck)
void	setSuspended(Boolean suspended)
void	setTenantIdIn(List<String> tenantIds)
void	setVer(Integer ver)	Deprecated. use setVersion(Integer)
void	setVersion(Integer version)
void	setVersionTag(String versionTag)
void	setVersionTagLike(String versionTagLike)
void	setWithoutTenantId(Boolean withoutTenantId)
void	setWithoutVersionTag(Boolean withoutVersionTag)

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

processDefinitionId

protected String processDefinitionId

processDefinitionIdIn

protected List<String> processDefinitionIdIn

category

protected String category

categoryLike

protected String categoryLike

name

protected String name

nameLike

protected String nameLike

deploymentId

protected String deploymentId

deployedAfter

protected Date deployedAfter

deployedAt

protected Date deployedAt

key

protected String key

keyLike

protected String keyLike

version

protected Integer version

latestVersion

protected Boolean latestVersion

resourceName

protected String resourceName

resourceNameLike

protected String resourceNameLike

startableBy

protected String startableBy

active

protected Boolean active

suspended

protected Boolean suspended

incidentId

protected String incidentId

incidentType

protected String incidentType

incidentMessage

protected String incidentMessage

incidentMessageLike

protected String incidentMessageLike

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

includeDefinitionsWithoutTenantId

protected Boolean includeDefinitionsWithoutTenantId

versionTag

protected String versionTag

versionTagLike

protected String versionTagLike

withoutVersionTag

protected Boolean withoutVersionTag

keys

protected List<String> keys

startableInTasklist

protected Boolean startableInTasklist

notStartableInTasklist

protected Boolean notStartableInTasklist

startablePermissionCheck

protected Boolean startablePermissionCheck

Constructor Detail

ProcessDefinitionQueryDto

public ProcessDefinitionQueryDto()

ProcessDefinitionQueryDto

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

Method Detail

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

setProcessDefinitionIdIn

public void setProcessDefinitionIdIn(List<String> processDefinitionIdIn)

setCategory

public void setCategory(String category)

setCategoryLike

public void setCategoryLike(String categoryLike)

setName

public void setName(String name)

setNameLike

public void setNameLike(String nameLike)

setDeploymentId

public void setDeploymentId(String deploymentId)

setDeployedAfter

public void setDeployedAfter(Date deployedAfter)

setDeployedAt

public void setDeployedAt(Date deployedAt)

setKey

public void setKey(String key)

setKeysIn

public void setKeysIn(List<String> keys)

setKeyLike

public void setKeyLike(String keyLike)

setVer

@Deprecated
public void setVer(Integer ver)

Deprecated.

use setVersion(Integer)

setVersion

public void setVersion(Integer version)

setLatest

@Deprecated
public void setLatest(Boolean latest)

Deprecated.

use setLatestVersion(Boolean)

setLatestVersion

public void setLatestVersion(Boolean latestVersion)

setResourceName

public void setResourceName(String resourceName)

setResourceNameLike

public void setResourceNameLike(String resourceNameLike)

setStartableBy

public void setStartableBy(String startableBy)

setActive

public void setActive(Boolean active)

setSuspended

public void setSuspended(Boolean suspended)

setIncidentId

public void setIncidentId(String incidentId)

setIncidentType

public void setIncidentType(String incidentType)

setIncidentMessage

public void setIncidentMessage(String incidentMessage)

setIncidentMessageLike

public void setIncidentMessageLike(String incidentMessageLike)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setIncludeProcessDefinitionsWithoutTenantId

public void setIncludeProcessDefinitionsWithoutTenantId(Boolean includeDefinitionsWithoutTenantId)

setVersionTag

public void setVersionTag(String versionTag)

setVersionTagLike

public void setVersionTagLike(String versionTagLike)

setWithoutVersionTag

public void setWithoutVersionTag(Boolean withoutVersionTag)

setStartableInTasklist

public void setStartableInTasklist(Boolean startableInTasklist)

setNotStartableInTasklist

public void setNotStartableInTasklist(Boolean notStartableInTasklist)

setStartablePermissionCheck

public void setStartablePermissionCheck(Boolean startablePermissionCheck)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<ProcessDefinitionQuery>

createNewQuery

protected ProcessDefinitionQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<ProcessDefinitionQuery>

applyFilters

protected void applyFilters(ProcessDefinitionQuery query)

Specified by:

applyFilters in class AbstractQueryDto<ProcessDefinitionQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<ProcessDefinitionQuery>