Module is.codion.framework.model

Package is.codion.framework.model

Interface ForeignKeyEditorLink.Builder

All Superinterfaces:

EditorLink.Builder

Enclosing interface:

ForeignKeyEditorLink

public static interface ForeignKeyEditorLink.Builder
extends EditorLink.Builder

Builds a ForeignKeyEditorLink.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EditorLink.Builder

EditorLink.Builder.EditorStep, EditorLink.Builder.ForeignKeyNameStep, EditorLink.Builder.LoadStep

Method Summary

Modifier and Type	Method	Description
ForeignKeyEditorLink.Builder	beforeInsert(EditorLink.BeforeInsert beforeInsert)	Overrides the EditorLink.BeforeInsert action.
ForeignKeyEditorLink	build()
ForeignKeyEditorLink.Builder	caption(String caption)	Sets the link caption.
ForeignKeyEditorLink.Builder	clearEmpty(boolean clearEmpty)	Specifies whether to clear all values instead of setting defaults when the detail editor is emptied on load, when no detail entity exists.
ForeignKeyEditorLink.Builder	condition(EditorLink.DetailCondition condition)	Overrides the default EditorLink.DetailCondition.
ForeignKeyEditorLink.Builder	entity(EditorLink.DetailEntity entity)	Overrides the default EditorLink.DetailEntity.
ForeignKeyEditorLink.Builder	name(String name)	Overrides the auto-derived link name.
ForeignKeyEditorLink.Builder	present(Predicate<Entity> present)	Sets the presence predicate for the detail editor.
ForeignKeyEditorLink.Builder	select(EditorLink.DetailSelect select)	Overrides the default EditorLink.DetailSelect.

Method Details

name

ForeignKeyEditorLink.Builder name(String name)

Overrides the auto-derived link name.

By default, FK-based links use foreignKey.name() as the link identifier. Override this when registering multiple FK-based detail editors that share the same foreign key but differ by condition (e.g., a single department's "manager" and "department head" details, both via Employee.DEPARTMENT_FK but filtered by different JOB values). Without an override the two would collide on the auto-derived name. After overriding, look up via EntityEditor.DetailEditors.get(String) rather than EntityEditor.DetailEditors.get(ForeignKey).

Parameters:

name - the link name, unique within the master's detail editors

Returns:

this builder

Throws:

IllegalArgumentException - if the name is null or empty

condition

ForeignKeyEditorLink.Builder condition(EditorLink.DetailCondition condition)

Overrides the default EditorLink.DetailCondition.

Note that this overrides select(DetailSelect). Useful when the relationship is the FK plus an additional filter (e.g., FK = master AND JOB = MANAGER).

Parameters:

condition - the condition used to load the detail row

Returns:

this builder

select

ForeignKeyEditorLink.Builder select(EditorLink.DetailSelect select)

Overrides the default EditorLink.DetailSelect. Useful when the relationship is the FK plus an additional filter (e.g., FK = master AND JOB = MANAGER).

Parameters:

select - the select used to load the detail row

Returns:

this builder

entity

ForeignKeyEditorLink.Builder entity(EditorLink.DetailEntity entity)

Overrides the default EditorLink.DetailEntity. Useful when the relationship can not be represented with a EntityConnection.Select or Condition.

Parameters:

entity - provides the detail row when loading

Returns:

this builder

present

ForeignKeyEditorLink.Builder present(Predicate<Entity> present)

Description copied from interface: EditorLink.Builder

Sets the presence predicate for the detail editor.

At registration time (EntityEditor.DetailEditors.add(EditorLink)) the supplied predicate is installed on the detail editor's EntityEditor.EditorEntity.present() state, replacing any previously-set predicate (it is not wrapped). The predicate is then locked: subsequent attempts to replace it via EntityEditor.Present.predicate() will fail. If a custom presence predicate is needed on a detail editor, supply it here rather than setting it directly on the editor before registration.

Specified by:

present in interface EditorLink.Builder

Parameters:

present - the presence predicate

Returns:

this builder

beforeInsert

ForeignKeyEditorLink.Builder beforeInsert(EditorLink.BeforeInsert beforeInsert)

Description copied from interface: EditorLink.Builder

Overrides the EditorLink.BeforeInsert action.

For FK-based links this overrides the default FK-set; the user must still ensure the foreign key gets set correctly if the framework's default is replaced.

Specified by:

beforeInsert in interface EditorLink.Builder

Parameters:

beforeInsert - the action applied to the detail prior to insertion

Returns:

this builder

caption

ForeignKeyEditorLink.Builder caption(String caption)

Description copied from interface: EditorLink.Builder

Sets the link caption.

The caption is the human-readable label used by the UI layer when disambiguating components — for example, the suffix in the "Select input field" dialog when the same attribute appears in multiple slots ("Tag (1)", "Tag (Manager)").

Defaults to the link name. Override when the link name is a structural identifier (e.g., the auto-derived foreignKey.name() or sequential numbers used to keep slot names unique) and a different label reads better in the UI.

Specified by:

caption in interface EditorLink.Builder

Parameters:

caption - the link caption

Returns:

this builder

clearEmpty

ForeignKeyEditorLink.Builder clearEmpty(boolean clearEmpty)

Description copied from interface: EditorLink.Builder

Specifies whether to clear all values instead of setting defaults when the detail editor is emptied on load, when no detail entity exists.

Specified by:

clearEmpty in interface EditorLink.Builder

Parameters:

clearEmpty - specifies whether to clear the values when the editor is emptied

Returns:

this builder

build

ForeignKeyEditorLink build()

Specified by:

build in interface EditorLink.Builder

Returns:

a new ForeignKeyEditorLink