Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

java.lang.Object

is.codion.framework.model.DefaultDetailModelLink<M,E,T>

is.codion.framework.model.DefaultForeignKeyDetailModelLink<M,E,T>

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

All Implemented Interfaces:

DetailModelLink<M,E,T>, ForeignKeyDetailModelLink<M,E,T>

public class DefaultForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>
extends DefaultDetailModelLink<M,E,T>
implements ForeignKeyDetailModelLink<M,E,T>

A default ForeignKeyDetailModelLink implementation.

Field Summary

Fields inherited from interface is.codion.framework.model.ForeignKeyDetailModelLink

CLEAR_FOREIGN_KEY_ON_EMPTY_SELECTION, REFRESH_ON_SELECTION, SEARCH_BY_INSERTED_ENTITY

Constructor Summary

Constructors

Constructor	Description
DefaultForeignKeyDetailModelLink(M detailModel, is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)

Method Summary

Modifier and Type	Method	Description
final 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.
final is.codion.framework.domain.entity.attribute.ForeignKey	foreignKey()
void	onDelete(Collection<is.codion.framework.domain.entity.Entity> deletedEntities)	Called when delete is performed in the master model, regardless of entity type.
void	onInsert(Collection<is.codion.framework.domain.entity.Entity> insertedEntities)	Called when a insert is performed in the master model, regardless of entity type.
void	onSelection(Collection<is.codion.framework.domain.entity.Entity> selectedEntities)	Called when the selection changes in the master model
void	onUpdate(Map<is.codion.framework.domain.entity.Entity.Key,is.codion.framework.domain.entity.Entity> updatedEntities)	Called when an update is performed in the master model, regardless of entity type.
final is.codion.common.state.State	refreshOnSelection()
final is.codion.common.state.State	searchByInsertedEntity()

Methods inherited from class is.codion.framework.model.DefaultDetailModelLink

active, detailModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface is.codion.framework.model.DetailModelLink

active, detailModel

Constructor Details

DefaultForeignKeyDetailModelLink

public DefaultForeignKeyDetailModelLink(M detailModel,
 is.codion.framework.domain.entity.attribute.ForeignKey foreignKey)

Parameters:

detailModel - the detail model

foreignKey - the foreign key to base this link on

Method Details

foreignKey

public final is.codion.framework.domain.entity.attribute.ForeignKey foreignKey()

Specified by:

foreignKey in interface ForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the foreign key representing this detail model

searchByInsertedEntity

public final is.codion.common.state.State searchByInsertedEntity()

Specified by:

searchByInsertedEntity in interface ForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

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:

• ForeignKeyDetailModelLink.SEARCH_BY_INSERTED_ENTITY

refreshOnSelection

public final is.codion.common.state.State refreshOnSelection()

Specified by:

refreshOnSelection in interface ForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

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:

• ForeignKeyDetailModelLink.REFRESH_ON_SELECTION

clearForeignKeyOnEmptySelection

public final is.codion.common.state.State clearForeignKeyOnEmptySelection()

Description copied from interface: ForeignKeyDetailModelLink

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.

Specified by:

clearForeignKeyOnEmptySelection in interface ForeignKeyDetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the State controlling whether a null selection should result in the foreign key being set to null

See Also:

• ForeignKeyDetailModelLink.CLEAR_FOREIGN_KEY_ON_EMPTY_SELECTION

onSelection

public void onSelection(Collection<is.codion.framework.domain.entity.Entity> selectedEntities)

Description copied from interface: DetailModelLink

Called when the selection changes in the master model

Specified by:

onSelection in interface DetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

selectedEntities - the selected master entities

onInsert

public void onInsert(Collection<is.codion.framework.domain.entity.Entity> insertedEntities)

Description copied from interface: DetailModelLink

Called when a insert is performed in the master model, regardless of entity type.

Specified by:

onInsert in interface DetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

insertedEntities - the inserted entities

onUpdate

public void onUpdate(Map<is.codion.framework.domain.entity.Entity.Key,is.codion.framework.domain.entity.Entity> updatedEntities)

Description copied from interface: DetailModelLink

Called when an update is performed in the master model, regardless of entity type.

Specified by:

onUpdate in interface DetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

updatedEntities - the updated entities, mapped to their original primary keys

onDelete

public void onDelete(Collection<is.codion.framework.domain.entity.Entity> deletedEntities)

Description copied from interface: DetailModelLink

Called when delete is performed in the master model, regardless of entity type.

Specified by:

onDelete in interface DetailModelLink<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

deletedEntities - the deleted entities