Package io.camunda.client.impl.search.filter

Class ProcessDefinitionFilterImpl

java.lang.Object

io.camunda.client.impl.search.request.TypedSearchRequestPropertyProvider<ProcessDefinitionFilter>

io.camunda.client.impl.search.filter.ProcessDefinitionFilterImpl

All Implemented Interfaces:

ProcessDefinitionFilter, TypedFilterableRequest.SearchRequestFilter

public class ProcessDefinitionFilterImpl
extends TypedSearchRequestPropertyProvider<ProcessDefinitionFilter>
implements ProcessDefinitionFilter

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitionFilterImpl()

Method Summary

Modifier and Type	Method	Description
protected ProcessDefinitionFilter	getSearchRequestProperty()
ProcessDefinitionFilter	hasStartForm(boolean hasStartForm)	Filters process definitions by having or not a form to start the process
ProcessDefinitionFilter	isLatestVersion(boolean latestVersion)	Filters process definitions to only include the latest version of each process definition.
ProcessDefinitionFilter	name(String name)	Filters process definitions by the specified name.
ProcessDefinitionFilter	name(Consumer<StringProperty> fn)	Filters process definitions by the specified name using StringProperty consumer.
ProcessDefinitionFilter	processDefinitionId(String processDefinitionId)	Filters process definitions by the specified process definition id.
ProcessDefinitionFilter	processDefinitionId(Consumer<StringProperty> fn)	Filters process definitions by the specified processDefinitionId using StringProperty consumer.
ProcessDefinitionFilter	processDefinitionKey(long processDefinitionKey)	Filters process definitions by the specified process definition key.
ProcessDefinitionFilter	resourceName(String resourceName)	Filters process definitions by the specified resource name.
ProcessDefinitionFilter	tenantId(String tenantId)	Filters process definitions by the specified tenant id.
ProcessDefinitionFilter	version(int version)	Filters process definitions by the specified version.
ProcessDefinitionFilter	versionTag(String versionTag)	Filters process definitions by the specified version tag.

Methods inherited from class io.camunda.client.impl.search.request.TypedSearchRequestPropertyProvider

provideSearchRequestProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProcessDefinitionFilterImpl

public ProcessDefinitionFilterImpl()

Method Details

isLatestVersion

public ProcessDefinitionFilter isLatestVersion(boolean latestVersion)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions to only include the latest version of each process definition.

Specified by:

isLatestVersion in interface ProcessDefinitionFilter

Returns:

the updated filter

processDefinitionKey

public ProcessDefinitionFilter processDefinitionKey(long processDefinitionKey)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified process definition key.

Specified by:

processDefinitionKey in interface ProcessDefinitionFilter

Parameters:

processDefinitionKey - the key of the process definition

Returns:

the updated filter

name

public ProcessDefinitionFilter name(String name)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified name.

Specified by:

name in interface ProcessDefinitionFilter

Parameters:

name - the name of the process definition

Returns:

the updated filter

name

public ProcessDefinitionFilter name(Consumer<StringProperty> fn)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified name using StringProperty consumer.

Specified by:

name in interface ProcessDefinitionFilter

Parameters:

fn - the name StringProperty consumer of the process definition

Returns:

the updated filter

resourceName

public ProcessDefinitionFilter resourceName(String resourceName)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified resource name.

Specified by:

resourceName in interface ProcessDefinitionFilter

Parameters:

resourceName - the resource name of the process definition

Returns:

the updated filter

version

public ProcessDefinitionFilter version(int version)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified version.

Specified by:

version in interface ProcessDefinitionFilter

Parameters:

version - the version of the process definition

Returns:

the updated filter

versionTag

public ProcessDefinitionFilter versionTag(String versionTag)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified version tag.

Specified by:

versionTag in interface ProcessDefinitionFilter

Parameters:

versionTag - the version tag of the process definition

Returns:

the updated filter

processDefinitionId

public ProcessDefinitionFilter processDefinitionId(String processDefinitionId)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified process definition id.

Specified by:

processDefinitionId in interface ProcessDefinitionFilter

Parameters:

processDefinitionId - the id of the process definition

Returns:

the updated filter

processDefinitionId

public ProcessDefinitionFilter processDefinitionId(Consumer<StringProperty> fn)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified processDefinitionId using StringProperty consumer.

Specified by:

processDefinitionId in interface ProcessDefinitionFilter

Parameters:

fn - the processDefinitionId StringProperty consumer of the process definition

Returns:

the updated filter

tenantId

public ProcessDefinitionFilter tenantId(String tenantId)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by the specified tenant id.

Specified by:

tenantId in interface ProcessDefinitionFilter

Parameters:

tenantId - the tenant id of the process definition.

Returns:

the updated filter

hasStartForm

public ProcessDefinitionFilter hasStartForm(boolean hasStartForm)

Description copied from interface: ProcessDefinitionFilter

Filters process definitions by having or not a form to start the process

Specified by:

hasStartForm in interface ProcessDefinitionFilter

Parameters:

hasStartForm - boolean to indicate how to filter

Returns:

the updated filter

getSearchRequestProperty

protected ProcessDefinitionFilter getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ProcessDefinitionFilter>