Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditor.SearchModels

Enclosing interface:

EntityEditor

public static interface EntityEditor.SearchModels

Manages the EntitySearchModels used by a EntityEditModel

Method Summary

Modifier and Type	Method	Description
EntitySearchModel	create(ForeignKey foreignKey)	Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.
EntitySearchModel	get(ForeignKey foreignKey)	Returns the EntitySearchModel associated with the given foreign key.

Method Details

get

EntitySearchModel get(ForeignKey foreignKey)

Returns the EntitySearchModel associated with the given foreign key. If no such search model exists, one is created by calling create(ForeignKey).

This method always returns the same EntitySearchModel instance, once one has been created.

Parameters:

foreignKey - the foreign key for which to retrieve the EntitySearchModel

Returns:

the EntitySearchModel associated with the given foreign key

create

EntitySearchModel create(ForeignKey foreignKey)

Creates a EntitySearchModel for looking up entities of the type referenced by the given foreign key, using the search attributes defined for that entity type.

Parameters:

foreignKey - the foreign key for which to create a EntitySearchModel

Returns:

a new EntitySearchModel for looking up entities of the type referenced by the given foreign key attribute,

Throws:

IllegalStateException - in case no searchable attributes can be found for the entity type referenced by the given foreign key