Module is.codion.framework.model
Package is.codion.framework.model
Interface ForeignKeyDetailModelLink<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>
- Type Parameters:
M
- theEntityModel
typeE
- theEntityEditModel
typeT
- theEntityTableModel
type
- All Superinterfaces:
DetailModelLink<M,
E, T>
- All Known Implementing Classes:
DefaultForeignKeyDetailModelLink
,SwingForeignKeyDetailModelLink
public interface ForeignKeyDetailModelLink<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>
extends DetailModelLink<M,E,T>
Represents a link between a master and detail model based on a foreign key.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final PropertyValue<Boolean>
Specifies whether a detail model sets the master foreign key to null when null or no value is selected in a master model
Value type: Boolean
Default value: falsestatic final PropertyValue<Boolean>
Specifies whether a detail model should be automatically refreshed when the selection in the master model changes.static final PropertyValue<Boolean>
Specifies whether a detail model should automatically search by the entity inserted by the master model. -
Method Summary
Modifier and TypeMethodDescriptionReturns the State controlling whether the detail model should set the foreign key to null when null or no value is selected in the master model.Methods inherited from interface is.codion.framework.model.DetailModelLink
active, detailModel, onDelete, onInsert, onSelection, onUpdate
-
Field Details
-
SEARCH_BY_INSERTED_ENTITY
Specifies whether a detail model should automatically search by the entity inserted by the master model. Value type: Boolean
Default value: false -
REFRESH_ON_SELECTION
Specifies whether a detail model should be automatically refreshed when the selection in the master model changes. Value type: Boolean
Default value: true -
CLEAR_FOREIGN_KEY_ON_EMPTY_SELECTION
Specifies whether a detail model sets the master foreign key to null when null or no value is selected in a master model
Value type: Boolean
Default value: false
-
-
Method Details
-
foreignKey
ForeignKey foreignKey()- Returns:
- the foreign key representing this detail model
-
searchByInsertedEntity
State searchByInsertedEntity()- Returns:
- the State controlling whether the detail table model should automatically search by the inserted entity when an insert is performed in a master model
- See Also:
-
refreshOnSelection
State refreshOnSelection()- Returns:
- the State controlling whether the detail table model should be automatically refreshed when the foreign key condition is set according to the master model selection
- See Also:
-
clearForeignKeyOnEmptySelection
State clearForeignKeyOnEmptySelection()Returns the State controlling whether the detail model should set the foreign key to null when null or no value is selected in the master model.- Returns:
- the State controlling whether a null selection should result in the foreign key being set to null
- See Also:
-