Module is.codion.framework.model

Package is.codion.framework.model

Interface ForeignKeyModelLink.Builder<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>,B extends ForeignKeyModelLink.Builder<M,E,T,R,B>>

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

R - the EntityEditor type

B - the builder type

All Superinterfaces:

ModelLink.Builder<M,E,T,R,B>

Enclosing interface:

ForeignKeyModelLink<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

public static interface ForeignKeyModelLink.Builder<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>,B extends ForeignKeyModelLink.Builder<M,E,T,R,B>>
extends ModelLink.Builder<M,E,T,R,B>

Builds a ForeignKeyModelLink

Method Summary

Modifier and Type	Method	Description
ForeignKeyModelLink<M,E,T,R>	build()
B	clearConditionOnEmptySelection(boolean clearConditionOnEmptySelection)
B	clearValueOnEmptySelection(boolean clearValueOnEmptySelection)
B	onInsert(Consumer<Collection<Entity>> onInsert)	Note that this overrides setValueOnInsert(boolean)
B	onSelection(Consumer<Collection<Entity>> onSelection)	Note that this overrides refreshOnSelection(boolean), clearConditionOnEmptySelection(boolean) and clearValueOnEmptySelection(boolean) Note that only active model links respond to parent model selection by default.
B	refreshOnSelection(boolean refreshOnSelection)	Note that only active model links respond to parent model selection by default.
B	setConditionOnInsert(boolean setConditionOnInsert)
B	setValueOnInsert(boolean setValueOnInsert)

Methods inherited from interface is.codion.framework.model.ModelLink.Builder

active, onDelete, onUpdate

Method Details

onSelection

B onSelection(Consumer<Collection<Entity>> onSelection)

Note that this overrides refreshOnSelection(boolean), clearConditionOnEmptySelection(boolean) and clearValueOnEmptySelection(boolean)
Note that only active model links respond to parent model selection by default.

Specified by:

onSelection in interface ModelLink.Builder<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>,B extends ForeignKeyModelLink.Builder<M,E,T,R,B>>

Parameters:

onSelection - called when the selection changes in the parent model

Returns:

this builder

See Also:

• ModelLink.active()

onInsert

B onInsert(Consumer<Collection<Entity>> onInsert)

Note that this overrides setValueOnInsert(boolean)

Specified by:

onInsert in interface ModelLink.Builder<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>,B extends ForeignKeyModelLink.Builder<M,E,T,R,B>>

Parameters:

onInsert - called when an insert is performed in the parent model

Returns:

this builder

setConditionOnInsert

B setConditionOnInsert(boolean setConditionOnInsert)

Parameters:

setConditionOnInsert - specifies whether the linked table model should automatically search by the inserted entity when an insert is performed in a parent model

Returns:

this builder

See Also:

• ForeignKeyModelLink.SET_CONDITION_ON_INSERT

setValueOnInsert

B setValueOnInsert(boolean setValueOnInsert)

Parameters:

setValueOnInsert - specifies whether the linked edit model should automatically set the foreign key value to the inserted entity

Returns:

this builder

See Also:

• ForeignKeyModelLink.SET_VALUE_ON_INSERT

refreshOnSelection

B refreshOnSelection(boolean refreshOnSelection)

Note that only active model links respond to parent model selection by default.

Parameters:

refreshOnSelection - specifies whether the linked table model should be automatically refreshed when the foreign key condition is set according to the parent model selection

Returns:

this builder

See Also:

• ForeignKeyModelLink.REFRESH_ON_SELECTION
• ModelLink.active()

clearValueOnEmptySelection

B clearValueOnEmptySelection(boolean clearValueOnEmptySelection)

Parameters:

clearValueOnEmptySelection - specifies whether the linked model should set the foreign key to null when null or no value is selected in the parent model.

Returns:

this builder

See Also:

• ForeignKeyModelLink.CLEAR_VALUE_ON_EMPTY_SELECTION

clearConditionOnEmptySelection

B clearConditionOnEmptySelection(boolean clearConditionOnEmptySelection)

Parameters:

clearConditionOnEmptySelection - specifies whether the linked table model should clear the foreign key search condition when no value is selected in the parent model

Returns:

this builder

See Also:

• ForeignKeyModelLink.CLEAR_CONDITION_ON_EMPTY_SELECTION

build

ForeignKeyModelLink<M,E,T,R> build()

Specified by:

build in interface ModelLink.Builder<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>,B extends ForeignKeyModelLink.Builder<M,E,T,R,B>>

Returns:

a ForeignKeyModelLink