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.ConnectionStep	Provides a EntitySearchModel.Builder
static interface	EntitySearchModel.Builder.EntityTypeStep	Provides a EntitySearchModel.Builder.ConnectionStep

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	filter(ForeignKey foreignKey, EntityComboBoxModel filterModel)	Links the given combo box model representing foreign key entities to this search model so that selection in the foreign key model filters this model.
EntitySearchModel.Builder	filter(ForeignKey foreignKey, EntitySearchModel filterModel)	Links the given search model representing foreign key entities to this search model so that selection in the foreign key model filters this model.
EntitySearchModel.Builder	limit(@Nullable Integer limit)
EntitySearchModel.Builder	orderBy(OrderBy orderBy)	Defaults to EntityDefinition.orderBy().
EntitySearchModel.Builder	persistenceAware(boolean persistenceAware)
EntitySearchModel.Builder	search(Column<String>... columns)
EntitySearchModel.Builder	search(Collection<Column<String>> columns)

Method Details

search

EntitySearchModel.Builder search(Column<String>... columns)

Parameters:

columns - the columns to search

Returns:

this builder

Throws:

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

search

EntitySearchModel.Builder search(Collection<Column<String>> columns)

Parameters:

columns - the columns to search

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

filter

EntitySearchModel.Builder filter(ForeignKey foreignKey,
 EntityComboBoxModel filterModel)

Links the given combo box model representing foreign key entities to this search model so that selection in the foreign key model filters this model.

Parameters:

foreignKey - the foreign key

filterModel - the combo box model filtering this model

Returns:

this builder instance

See Also:

• ForeignKeyFilter.link(EntityComboBoxModel)

filter

EntitySearchModel.Builder filter(ForeignKey foreignKey,
 EntitySearchModel filterModel)

Links the given search model representing foreign key entities to this search model so that selection in the foreign key model filters this model.

Parameters:

foreignKey - the foreign key

filterModel - the search model filtering this model

Returns:

this builder instance

See Also:

• ForeignKeyFilter.link(EntitySearchModel)

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

persistenceAware

EntitySearchModel.Builder persistenceAware(boolean persistenceAware)

Parameters:

persistenceAware - controls whether this search model should respond to entity persistence events, by replacing the selected entity when updated and clearing it when deleted

Returns:

this builder instance

See Also:

• PersistenceEvents

limit

EntitySearchModel.Builder limit(@Nullable Integer limit)

Parameters:

limit - the search result limit, null for no limit

Returns:

this builder

build

EntitySearchModel build()

Returns:

a new EntitySearchModel based on this builder