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

Class ElementInstanceFilterImpl

java.lang.Object

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

io.camunda.client.impl.search.filter.ElementInstanceFilterImpl

All Implemented Interfaces:

ElementInstanceFilter, TypedFilterableRequest.SearchRequestFilter

public class ElementInstanceFilterImpl
extends TypedSearchRequestPropertyProvider<ElementInstanceFilter>
implements ElementInstanceFilter

Constructor Summary

Constructors

Constructor	Description
ElementInstanceFilterImpl()

Method Summary

Modifier and Type	Method	Description
ElementInstanceFilter	elementId(String value)	Filters element instances by element id.
ElementInstanceFilter	elementInstanceKey(long value)	Filters element instances by the specified key.
ElementInstanceFilter	elementInstanceScopeKey(long value)	Filters element instances by the specified scope key.
ElementInstanceFilter	elementName(String value)	Filters element instances by element name.
ElementInstanceFilter	endDate(OffsetDateTime endDate)	Filters element instances by end date.
ElementInstanceFilter	endDate(Consumer<DateTimeProperty> fn)	Filters element instances by the specified DateTimeProperty end date.
protected ElementInstanceFilter	getSearchRequestProperty()
ElementInstanceFilter	hasIncident(boolean value)	Filters element instances by incident (has an incident)
ElementInstanceFilter	incidentKey(long value)	Filters element instances by incident key.
ElementInstanceFilter	processDefinitionId(String value)	Filters element instances by bpmn process id.
ElementInstanceFilter	processDefinitionKey(long value)	Filters element instances by process definition key.
ElementInstanceFilter	processInstanceKey(long value)	Filters element instances by process instance key.
ElementInstanceFilter	startDate(OffsetDateTime startDate)	Filters element instances by start date.
ElementInstanceFilter	startDate(Consumer<DateTimeProperty> fn)	Filters element instances by the specified DateTimeProperty start date.
ElementInstanceFilter	state(ElementInstanceState value)	Filters element instances by state.
ElementInstanceFilter	state(Consumer<ElementInstanceStateProperty> fn)	Filter by state using ElementInstanceStateProperty consumer
ElementInstanceFilter	tenantId(String value)	Filters element instances by tenant id.
ElementInstanceFilter	type(ElementInstanceType value)	Filters element instances by type.

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

ElementInstanceFilterImpl

public ElementInstanceFilterImpl()

Method Details

elementInstanceKey

public ElementInstanceFilter elementInstanceKey(long value)

Description copied from interface: ElementInstanceFilter

Filters element instances by the specified key.

Specified by:

elementInstanceKey in interface ElementInstanceFilter

Parameters:

value - the key of element instance

Returns:

the updated filter

processDefinitionKey

public ElementInstanceFilter processDefinitionKey(long value)

Description copied from interface: ElementInstanceFilter

Filters element instances by process definition key.

Specified by:

processDefinitionKey in interface ElementInstanceFilter

Parameters:

value - the process definition key of element instance

Returns:

the updated filter

processDefinitionId

public ElementInstanceFilter processDefinitionId(String value)

Description copied from interface: ElementInstanceFilter

Filters element instances by bpmn process id.

Specified by:

processDefinitionId in interface ElementInstanceFilter

Parameters:

value - the bpmn process id of element instance

Returns:

the updated filter

processInstanceKey

public ElementInstanceFilter processInstanceKey(long value)

Description copied from interface: ElementInstanceFilter

Filters element instances by process instance key.

Specified by:

processInstanceKey in interface ElementInstanceFilter

Parameters:

value - the process instance key of element instance

Returns:

the updated filter

elementId

public ElementInstanceFilter elementId(String value)

Description copied from interface: ElementInstanceFilter

Filters element instances by element id.

Specified by:

elementId in interface ElementInstanceFilter

Parameters:

value - the element id of element instance

Returns:

the updated filter

elementName

public ElementInstanceFilter elementName(String value)

Description copied from interface: ElementInstanceFilter

Filters element instances by element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data.

Specified by:

elementName in interface ElementInstanceFilter

Parameters:

value - the element name of element instance

Returns:

the updated filter

state

public ElementInstanceFilter state(ElementInstanceState value)

Description copied from interface: ElementInstanceFilter

Filters element instances by state.

Specified by:

state in interface ElementInstanceFilter

Parameters:

value - the state of element instance

Returns:

the updated filter

state

public ElementInstanceFilter state(Consumer<ElementInstanceStateProperty> fn)

Description copied from interface: ElementInstanceFilter

Filter by state using ElementInstanceStateProperty consumer

Specified by:

state in interface ElementInstanceFilter

type

public ElementInstanceFilter type(ElementInstanceType value)

Description copied from interface: ElementInstanceFilter

Filters element instances by type.

Specified by:

type in interface ElementInstanceFilter

Parameters:

value - the type of element instance

Returns:

the updated filter

hasIncident

public ElementInstanceFilter hasIncident(boolean value)

Description copied from interface: ElementInstanceFilter

Filters element instances by incident (has an incident)

Specified by:

hasIncident in interface ElementInstanceFilter

Parameters:

value - has the element instance an incident

Returns:

the updated filter

incidentKey

public ElementInstanceFilter incidentKey(long value)

Description copied from interface: ElementInstanceFilter

Filters element instances by incident key.

Specified by:

incidentKey in interface ElementInstanceFilter

Parameters:

value - the incident key for element instance

Returns:

the updated filter

tenantId

public ElementInstanceFilter tenantId(String value)

Description copied from interface: ElementInstanceFilter

Filters element instances by tenant id.

Specified by:

tenantId in interface ElementInstanceFilter

Parameters:

value - the tenant id for element instance

Returns:

the updated filter

startDate

public ElementInstanceFilter startDate(OffsetDateTime startDate)

Description copied from interface: ElementInstanceFilter

Filters element instances by start date.

Specified by:

startDate in interface ElementInstanceFilter

Parameters:

startDate - the start date of the element instance

Returns:

the updated filter

startDate

public ElementInstanceFilter startDate(Consumer<DateTimeProperty> fn)

Description copied from interface: ElementInstanceFilter

Filters element instances by the specified DateTimeProperty start date.

Specified by:

startDate in interface ElementInstanceFilter

Parameters:

fn - the start date of the element instance

Returns:

the updated filter

endDate

public ElementInstanceFilter endDate(OffsetDateTime endDate)

Description copied from interface: ElementInstanceFilter

Filters element instances by end date.

Specified by:

endDate in interface ElementInstanceFilter

Parameters:

endDate - the end date of the element instance

Returns:

the updated filter

endDate

public ElementInstanceFilter endDate(Consumer<DateTimeProperty> fn)

Description copied from interface: ElementInstanceFilter

Filters element instances by the specified DateTimeProperty end date.

Specified by:

endDate in interface ElementInstanceFilter

Parameters:

fn - the end date of the element instance

Returns:

the updated filter

elementInstanceScopeKey

public ElementInstanceFilter elementInstanceScopeKey(long value)

Description copied from interface: ElementInstanceFilter

Filters element instances by the specified scope key.

Specified by:

elementInstanceScopeKey in interface ElementInstanceFilter

Parameters:

value - the scope key of the element instance

Returns:

the updated filter

getSearchRequestProperty

protected ElementInstanceFilter getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<ElementInstanceFilter>