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.

Method Summary

Modifier and Type	Method	Description
EntitySearchModel	build()
EntitySearchModel.Builder	columns(Collection<Column<String>> columns)
EntitySearchModel.Builder	description(String description)
EntitySearchModel.Builder	limit(int limit)
EntitySearchModel.Builder	separator(String multipleItemSeparator)	Default ','
EntitySearchModel.Builder	singleSelection(boolean singleSelection)	Default false
EntitySearchModel.Builder	stringFunction(Function<Entity,String> stringFunction)	Override the default toString() for search elements when displayed in a field based on this model

Method Details

columns

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

Parameters:

columns - the columns to search by

Returns:

this builder

Throws:

IllegalArgumentException - in case columns is empty

stringFunction

EntitySearchModel.Builder stringFunction(Function<Entity,String> stringFunction)

Override the default toString() for search elements when displayed in a field based on this model

Parameters:

stringFunction - the function providing the toString() functionality

Returns:

this builder

description

EntitySearchModel.Builder description(String description)

Parameters:

description - the description

Returns:

this builder

singleSelection

EntitySearchModel.Builder singleSelection(boolean singleSelection)

Default false

Parameters:

singleSelection - true if single selection should be enabled

Returns:

this builder

separator

EntitySearchModel.Builder separator(String multipleItemSeparator)

Default ','

Parameters:

multipleItemSeparator - the text used to separate multiple selected items

Returns:

this builder

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