Package io.camunda.client.api.search.request

Interface TypedSearchRequest<F extends TypedSearchRequest.SearchRequestFilter,S extends TypedSearchRequest.SearchRequestSort<S>,SELF extends TypedSearchRequest<F,S,SELF>>

All Known Subinterfaces:

BatchOperationItemSearchRequest, BatchOperationSearchRequest, ClientsByRoleSearchRequest, DecisionDefinitionSearchRequest, DecisionInstanceSearchRequest, DecisionRequirementsSearchRequest, ElementInstanceSearchRequest, GroupsSearchRequest, IncidentSearchRequest, MappingsByGroupSearchRequest, MappingsByRoleSearchRequest, ProcessDefinitionSearchRequest, ProcessInstanceSearchRequest, RolesByGroupSearchRequest, RolesByTenantSearchRequest, RolesSearchRequest, UsersByGroupSearchRequest, UsersByRoleSearchRequest, UserTaskSearchRequest, UserTaskVariableSearchRequest, VariableSearchRequest

All Known Implementing Classes:

BatchOperationItemSearchRequestImpl, BatchOperationSearchRequestImpl, ClientsByRoleSearchRequestImpl, DecisionDefinitionSearchRequestImpl, DecisionInstanceSearchRequestImpl, DecisionRequirementsSearchRequestImpl, ElementInstanceSearchRequestImpl, GroupSearchRequestImpl, IncidentSearchRequestImpl, MappingsByGroupSearchRequestImpl, MappingsByRoleSearchRequestImpl, ProcessDefinitionSearchRequestImpl, ProcessInstanceSearchRequestImpl, RolesByGroupSearchRequestImpl, RolesByTenantSearchRequestImpl, RolesSearchRequestImpl, UsersByGroupSearchRequestImpl, UsersByRoleSearchRequestImpl, UserTaskSearchRequestImpl, UserTaskVariableSearchRequestImpl, VariableSearchRequestImpl

public interface TypedSearchRequest<F extends TypedSearchRequest.SearchRequestFilter,S extends TypedSearchRequest.SearchRequestSort<S>,SELF extends TypedSearchRequest<F,S,SELF>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TypedSearchRequest.SearchRequestFilter
static interface	TypedSearchRequest.SearchRequestSort<S extends TypedSearchRequest.SearchRequestSort<S>>

Method Summary

Modifier and Type	Method	Description
SELF	filter(F value)	Sets the filter to be included in the search request.
SELF	filter(Consumer<F> fn)	Provides a fluent builder to create a filter to be included in the search request.
SELF	page(SearchRequestPage value)	Support for pagination.
SELF	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
SELF	sort(Consumer<S> fn)	Provides a fluent builder to provide sorting options the returned entites should sorted by
SELF	sort(S value)	Sets the sorting the returned entities should be sorted by.

Method Details

filter

SELF filter(F value)

Sets the filter to be included in the search request.

Parameters:

value - the filter

Returns:

the builder for the search request

filter

SELF filter(Consumer<F> fn)

Provides a fluent builder to create a filter to be included in the search request.

Parameters:

fn - consumer to create the filter

Returns:

the builder for the search request

sort

SELF sort(S value)

Sets the sorting the returned entities should be sorted by.

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

SELF sort(Consumer<S> fn)

Provides a fluent builder to provide sorting options the returned entites should sorted by

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

page

SELF page(SearchRequestPage value)

Support for pagination.

Parameters:

value - the next page

Returns:

the builder for the search request

page

SELF page(Consumer<SearchRequestPage> fn)

Provides a fluent builder to support pagination.

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request