Module is.codion.framework.model

Package is.codion.framework.model

Interface EditorLink.Builder.LoadStep

Enclosing interface:

EditorLink.Builder

public static interface EditorLink.Builder.LoadStep

Required after EditorLink.Builder.ForeignKeyNameStep.name(String) — supplies the load source for the detail entity, expressed as a EditorLink.DetailCondition, EditorLink.DetailSelect or EditorLink.DetailEntity.

Method Summary

Modifier and Type	Method	Description
EditorLink.Builder	condition(EditorLink.DetailCondition condition)	Loads the detail row using the Condition produced for each master entity.
EditorLink.Builder	entity(EditorLink.DetailEntity entity)	Loads the detail row using a user-supplied function — the lowest-level escape hatch when neither a EditorLink.DetailCondition nor a EditorLink.DetailSelect suffices (e.g.
EditorLink.Builder	select(EditorLink.DetailSelect select)	Loads the detail row using the EntityConnection.Select produced for each master entity.

Method Details

condition

EditorLink.Builder condition(EditorLink.DetailCondition condition)

Loads the detail row using the Condition produced for each master entity.

The condition must produce 0 or 1 rows; multiple matches result in an IllegalStateException at load time.

Parameters:

condition - provides the Condition used to load the detail row given the master entity

Returns:

a builder for further configuration

select

EditorLink.Builder select(EditorLink.DetailSelect select)

Loads the detail row using the EntityConnection.Select produced for each master entity.

The select must produce 0 or 1 rows; multiple matches result in an IllegalStateException at load time.

Parameters:

select - provides the EntityConnection.Select used to load the detail row given the master entity

Returns:

a builder for further configuration

entity

EditorLink.Builder entity(EditorLink.DetailEntity entity)

Loads the detail row using a user-supplied function — the lowest-level escape hatch when neither a EditorLink.DetailCondition nor a EditorLink.DetailSelect suffices (e.g. when the detail entity is computed rather than selected, or requires multiple round trips).

The supplied function must produce at most one entity; cardinality is the caller's responsibility on this path.

Parameters:

entity - provides the detail entity given the master entity

Returns:

a builder for further configuration