EntitySearchModel.Builder

Enclosing interface:: EntitySearchModel

public static interface EntitySearchModel.Builder

A builder for a EntitySearchModel.

Method Summary

Modifier and Type

Method

Description

EntitySearchModel.Builder

attributes(Collection<Attribute<?>> attributes)

EntitySearchModel

build()

EntitySearchModel.Builder

columns(Collection<Column<String>> columns)

EntitySearchModel.Builder

limit(int limit)

EntitySearchModel.Builder

orderBy(OrderBy orderBy)

Defaults to EntityDefinition.orderBy().

EntitySearchModel.Builder

singleSelection(boolean singleSelection)

Default false

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 or a column is not associated with the underlying entity
- 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
- singleSelection
  
  EntitySearchModel.Builder singleSelection(boolean singleSelection)
  
  Default false
  
  Parameters:
  
  singleSelection - true if single selection should be enabled
  
  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