Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

R - the EntityEditor type

All Known Implementing Classes:

DefaultEntityModel, SwingEntityModel

public interface EntityModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>

Specifies a class responsible for, among other things, coordinating a EntityEditModel and an EntityTableModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityModel.DetailModels<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<M,E,T,R>,T extends EntityTableModel<M,E,T,R>,R extends EntityEditor<M,E,T,R>>	Manages the detail models for a EntityModel

Method Summary

Modifier and Type	Method	Description
EntityConnection	connection()	Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.
EntityConnectionProvider	connectionProvider()
boolean	containsTableModel()
EntityModel.DetailModels<M,E,T,R>	detailModels()
E	editModel()
Entities	entities()
EntityDefinition	entityDefinition()
EntityType	entityType()
<B extends ForeignKeyModelLink.Builder<M, E, T, R, B>> ForeignKeyModelLink.Builder<M,E,T,R,B>	link(M model)
T	tableModel()

Method Details

entityType

EntityType entityType()

Returns:

the type of the entity this entity model is based on

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this entity model

connection

EntityConnection connection()

Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.

Returns:

the connection used by this entity model

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the definition of the underlying entity

editModel

E editModel()

Returns:

the EntityEditModel instance used by this EntityModel

tableModel

T tableModel()

Returns:

the EntityTableModel

Throws:

IllegalStateException - in case no table model is available

containsTableModel

boolean containsTableModel()

Returns:

true if this EntityModel contains a EntityTableModel

link

<B extends ForeignKeyModelLink.Builder<M,
E,
T,
R,
B>>
ForeignKeyModelLink.Builder<M,E,T,R,B> link(M model)

Type Parameters:

B - the builder type

Parameters:

model - the model to link to

Returns:

a ForeignKeyModelLink.Builder, based on a fitting foreign key

Throws:

IllegalArgumentException - in case zero or multiple fitting foreign keys are found

detailModels

EntityModel.DetailModels<M,E,T,R> detailModels()

Returns:

the detail models