Module is.codion.framework.model

Package is.codion.framework.model

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

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

R - the EntityEditor type

All Known Implementing Classes:

DefaultEntityEditModel, SwingEntityEditModel

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

Specifies a class for editing an Entity instance. The underlying attribute values are available via EntityEditor.value(Attribute).

See Also:

• editor()

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()
R	editor()	Returns a EntityEditor wrapping the entity being edited.
Entities	entities()
EntityDefinition	entityDefinition()
EntityType	entityType()

Method Details

entityType

EntityType entityType()

Returns:

the type of the entity this edit model is based on

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider used by this edit 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 edit model

editor

R editor()

Returns a EntityEditor wrapping the entity being edited. EntityEditor.EditorEntity.get() returns an immutable copy of the Entity instance being edited, while EntityEditor.EditorEntity.set(Entity) copies the values from the given Entity into the underlying Entity. Note that value changes must go through the EntityEditor.EditorValue accessible via EntityEditor.value(Attribute).

Returns:

the EntityEditor wrapping the Entity instance being edited

See Also:

• Entity.immutable()

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the definition of the underlying entity