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

Class CaseDefinitionQueryDto

java.lang.Object

org.operaton.bpm.engine.rest.dto.AbstractSearchQueryDto

org.operaton.bpm.engine.rest.dto.AbstractQueryDto<CaseDefinitionQuery>

org.operaton.bpm.engine.rest.dto.repository.CaseDefinitionQueryDto

public class CaseDefinitionQueryDto
extends AbstractQueryDto<CaseDefinitionQuery>

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
protected String	caseDefinitionId
protected List<String>	caseDefinitionIdIn
protected String	category
protected String	categoryLike
protected String	deploymentId
protected Boolean	includeDefinitionsWithoutTenantId
protected String	key
protected String	keyLike
protected Boolean	latestVersion
protected String	name
protected String	nameLike
protected String	resourceName
protected String	resourceNameLike
protected List<String>	tenantIds
protected Integer	version
protected Boolean	withoutTenantId

Fields inherited from class org.operaton.bpm.engine.rest.dto.AbstractQueryDto

expressions, sortBy, sortings, sortOrder

Fields inherited from class org.operaton.bpm.engine.rest.dto.AbstractSearchQueryDto

objectMapper

Constructor Summary

Constructors

Constructor	Description
CaseDefinitionQueryDto()
CaseDefinitionQueryDto(com.fasterxml.jackson.databind.ObjectMapper objectMapper, jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters)

Method Summary

Modifier and Type	Method	Description
protected void	applyFilters(CaseDefinitionQuery query)
protected void	applySortBy(CaseDefinitionQuery query, String sortBy, Map<String,Object> parameters, ProcessEngine engine)
protected CaseDefinitionQuery	createNewQuery(ProcessEngine engine)
protected boolean	isValidSortByValue(String value)
void	setCaseDefinitionId(String caseDefinitionId)
void	setCaseDefinitionIdIn(List<String> caseDefinitionIdIn)
void	setCategory(String category)
void	setCategoryLike(String categoryLike)
void	setDeploymentId(String deploymentId)
void	setIncludeCaseDefinitionsWithoutTenantId(Boolean includeDefinitionsWithoutTenantId)
void	setKey(String key)
void	setKeyLike(String keyLike)
void	setLatest(Boolean latest)	Deprecated, for removal: This API element is subject to removal in a future version. Use setLatestVersion(Boolean) instead.
void	setLatestVersion(Boolean latestVersion)
void	setName(String name)
void	setNameLike(String nameLike)
void	setResourceName(String resourceName)
void	setResourceNameLike(String resourceNameLike)
void	setTenantIdIn(List<String> tenantIds)
void	setVersion(Integer version)
void	setWithoutTenantId(Boolean withoutTenantId)

Methods inherited from class org.operaton.bpm.engine.rest.dto.AbstractQueryDto

applySortingOptions, applySortOrder, getSorting, setSortBy, setSorting, setSortOrder, sortOptionsValid, sortOrderValueForDirection, toQuery

Methods inherited from class org.operaton.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

caseDefinitionId

protected String caseDefinitionId

caseDefinitionIdIn

protected List<String> caseDefinitionIdIn

category

protected String category

categoryLike

protected String categoryLike

name

protected String name

nameLike

protected String nameLike

deploymentId

protected String deploymentId

key

protected String key

keyLike

protected String keyLike

resourceName

protected String resourceName

resourceNameLike

protected String resourceNameLike

version

protected Integer version

latestVersion

protected Boolean latestVersion

tenantIds

protected List<String> tenantIds

withoutTenantId

protected Boolean withoutTenantId

includeDefinitionsWithoutTenantId

protected Boolean includeDefinitionsWithoutTenantId

Constructor Details

CaseDefinitionQueryDto

public CaseDefinitionQueryDto()

CaseDefinitionQueryDto

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

Method Details

setCaseDefinitionId

public void setCaseDefinitionId(String caseDefinitionId)

setCaseDefinitionIdIn

public void setCaseDefinitionIdIn(List<String> caseDefinitionIdIn)

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)

setKey

public void setKey(String key)

setKeyLike

public void setKeyLike(String keyLike)

setResourceName

public void setResourceName(String resourceName)

setResourceNameLike

public void setResourceNameLike(String resourceNameLike)

setVersion

public void setVersion(Integer version)

setLatest

@Deprecated(forRemoval=true,
            since="1.0")
public void setLatest(Boolean latest)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setLatestVersion(Boolean) instead.

setLatestVersion

public void setLatestVersion(Boolean latestVersion)

setTenantIdIn

public void setTenantIdIn(List<String> tenantIds)

setWithoutTenantId

public void setWithoutTenantId(Boolean withoutTenantId)

setIncludeCaseDefinitionsWithoutTenantId

public void setIncludeCaseDefinitionsWithoutTenantId(Boolean includeDefinitionsWithoutTenantId)

isValidSortByValue

protected boolean isValidSortByValue(String value)

Specified by:

isValidSortByValue in class AbstractQueryDto<CaseDefinitionQuery>

createNewQuery

protected CaseDefinitionQuery createNewQuery(ProcessEngine engine)

Specified by:

createNewQuery in class AbstractQueryDto<CaseDefinitionQuery>

applyFilters

protected void applyFilters(CaseDefinitionQuery query)

Specified by:

applyFilters in class AbstractQueryDto<CaseDefinitionQuery>

applySortBy

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

Specified by:

applySortBy in class AbstractQueryDto<CaseDefinitionQuery>