Module is.codion.framework.model

Package is.codion.framework.model

Interface ForeignKeyModelLink

All Superinterfaces:

ModelLink

public sealed interface ForeignKeyModelLink
extends ModelLink

Represents a link between two entity models based on a foreign key.

The master selection is applied to the detail once: a selection the link has already applied is ignored, whether it arrives with the link being activated anew or with the master refreshing and notifying with fresher instances of the same rows. A detail condition changed by hand therefore survives navigation and refresh, a changed master selection overrules it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ForeignKeyModelLink.Builder<B extends ForeignKeyModelLink.Builder<B>>	Builds a ForeignKeyModelLink

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	CLEAR_CONDITION_ON_EMPTY_SELECTION	Specifies whether a linked model clears the foreign key search condition when null or no value is selected in a parent model Value type: Boolean Default value: true
static final PropertyValue<Boolean>	CLEAR_VALUE_ON_EMPTY_SELECTION	Specifies whether a linked model sets the parent foreign key value to null when null or no value is selected in a parent model Value type: Boolean Default value: false
static final PropertyValue<Boolean>	REFRESH_ON_SELECTION	Specifies whether a linked model should be automatically refreshed when the selection in the parent model changes.
static final PropertyValue<Boolean>	SET_CONDITION_ON_INSERT	Specifies whether a linked model should automatically search by the entity inserted by the parent model.
static final PropertyValue<Boolean>	SET_VALUE_ON_INSERT	Specifies whether a linked model should automatically set the foreign key value to the entity inserted by the parent model.

Method Summary

Modifier and Type	Method	Description
static ForeignKeyModelLink.Builder.ModelStep	builder()	Returns a new ForeignKeyModelLink.Builder.ModelStep instance.
ForeignKey	foreignKey()

Field Details

SET_VALUE_ON_INSERT

static final PropertyValue<Boolean> SET_VALUE_ON_INSERT

Specifies whether a linked model should automatically set the foreign key value to the entity inserted by the parent model.

• Value type: Boolean
• Default value: true

SET_CONDITION_ON_INSERT

static final PropertyValue<Boolean> SET_CONDITION_ON_INSERT

Specifies whether a linked model should automatically search by the entity inserted by the parent model.

• Value type: Boolean
• Default value: false

REFRESH_ON_SELECTION

static final PropertyValue<Boolean> REFRESH_ON_SELECTION

Specifies whether a linked model should be automatically refreshed when the selection in the parent model changes.

• Value type: Boolean
• Default value: true

CLEAR_VALUE_ON_EMPTY_SELECTION

static final PropertyValue<Boolean> CLEAR_VALUE_ON_EMPTY_SELECTION

Specifies whether a linked model sets the parent foreign key value to null when null or no value is selected in a parent model

• Value type: Boolean
• Default value: false

CLEAR_CONDITION_ON_EMPTY_SELECTION

static final PropertyValue<Boolean> CLEAR_CONDITION_ON_EMPTY_SELECTION

Specifies whether a linked model clears the foreign key search condition when null or no value is selected in a parent model

• Value type: Boolean
• Default value: true

Method Details

foreignKey

ForeignKey foreignKey()

Returns:

the foreign key this link is based on

builder

static ForeignKeyModelLink.Builder.ModelStep builder()

Returns a new ForeignKeyModelLink.Builder.ModelStep instance.

Returns:

a ForeignKeyModelLink.Builder.ModelStep instance