Module is.codion.framework.model

Package is.codion.framework.model

Interface EntitySearchModel.Builder

Enclosing interface:

EntitySearchModel

public static interface EntitySearchModel.Builder

A builder for a EntitySearchModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntitySearchModel.Builder.ConnectionProviderStep	Provides a EntitySearchModel.Builder
static interface	EntitySearchModel.Builder.EntityTypeStep	Provides a EntitySearchModel.Builder.ConnectionProviderStep

Method Summary

Modifier and Type	Method	Description
EntitySearchModel.Builder	attributes(Collection<Attribute<?>> attributes)
EntitySearchModel	build()
EntitySearchModel.Builder	condition(Supplier<Condition> condition)	The condition supplier may not return null, doing so will cause an exception when searching.
EntitySearchModel.Builder	editEvents(boolean editEvents)
EntitySearchModel.Builder	limit(int limit)
EntitySearchModel.Builder	orderBy(OrderBy orderBy)	Defaults to EntityDefinition.orderBy().
EntitySearchModel.Builder	searchColumns(Collection<Column<String>> searchColumns)

Method Details

searchColumns

EntitySearchModel.Builder searchColumns(Collection<Column<String>> searchColumns)

Parameters:

searchColumns - the columns to search by

Returns:

this builder

Throws:

IllegalArgumentException - in case columns is empty or a column is not associated with the underlying entity

condition

EntitySearchModel.Builder condition(Supplier<Condition> condition)

The condition supplier may not return null, doing so will cause an exception when searching.

Parameters:

condition - the additional condition supplier to use when performing the search

Returns:

this builder instance

attributes

EntitySearchModel.Builder attributes(Collection<Attribute<?>> attributes)

Parameters:

attributes - the attributes to include when querying entities from the database, an empty Collection means all

Returns:

this builder

Throws:

IllegalArgumentException - in case an attribute is not associated with the underlying entity

orderBy

EntitySearchModel.Builder orderBy(OrderBy orderBy)

Defaults to EntityDefinition.orderBy().

Parameters:

orderBy - the OrderBy to use when querying entities from the database

Returns:

this builder

editEvents

EntitySearchModel.Builder editEvents(boolean editEvents)

Parameters:

editEvents - controls whether this search model should handle entity edit events, by updating any updated items and removing deleted ones

Returns:

this builder instance

See Also:

• EntityEditModel.EditEvents

limit

EntitySearchModel.Builder limit(int limit)

Parameters:

limit - the search result limit

Returns:

this builder

build

EntitySearchModel build()

Returns:

a new EntitySearchModel based on this builder