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 - the EntityModel type
E - the EntityEditModel type
T - the EntityTableModel type
All Superinterfaces:
DetailModelLink<M,E,T>
All Known Implementing Classes:
DefaultForeignKeyDetailModelLink
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

    Fields
    Modifier and Type
    Field
    Description
    static final is.codion.common.property.PropertyValue<Boolean>
    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
    static final is.codion.common.property.PropertyValue<Boolean>
    REFRESH_ON_SELECTION
    Specifies whether a detail model should be automatically refreshed when the selection in the master model changes.
    static final is.codion.common.property.PropertyValue<Boolean>
    SEARCH_BY_INSERTED_ENTITY
    Specifies whether a detail model should automatically search by the entity inserted by the master model.

  • Method Summary

    Modifier and Type
    Method
    Description
    is.codion.common.state.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.
    is.codion.framework.domain.entity.attribute.ForeignKey
    foreignKey()
     
    is.codion.common.state.State
    refreshOnSelection()
     
    is.codion.common.state.State
    searchByInsertedEntity()
     
    active, detailModel, onDelete, onInsert, onSelection, onUpdate

  • Field Details

    • SEARCH_BY_INSERTED_ENTITY

      static final is.codion.common.property.PropertyValue<Boolean> 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

      static final is.codion.common.property.PropertyValue<Boolean> 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

      static final is.codion.common.property.PropertyValue<Boolean> 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

      is.codion.framework.domain.entity.attribute.ForeignKey foreignKey()
      Returns:
      the foreign key representing this detail model

    • searchByInsertedEntity

      is.codion.common.state.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

      is.codion.common.state.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

      is.codion.common.state.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: