Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditModel

All Known Implementing Classes:

DefaultEntityEditModel, SwingEntityEditModel

public interface EntityEditModel

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

See Also:

• editor()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditModel.PersistEvents	Provides event observers for the edit model.
static interface	EntityEditModel.PersistTask	Represents a task for persisting entities, inserting, updating or deleting, split up for use with a background thread.
static interface	EntityEditModel.PersistTasks	Provides EntityEditModel.PersistTasks
static interface	EntityEditModel.Settings	The edit model settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	PUBLISH_PERSISTENCE_EVENTS	Specifies whether edit models publish their insert, update and delete events to PersistenceEvents Value type: Boolean Default value: true

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()
Entity	delete()	Note: This method must be called on the UI thread in case a panel has been based on this model.
Collection<Entity>	delete(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.
EntityEditor	editor()	Returns a EntityEditor wrapping the entity being edited.
Entities	entities()
EntityDefinition	entityDefinition()
EntityType	entityType()
EntityEditModel.PersistEvents	events()
Entity	insert()	Note: This method must be called on the UI thread in case a panel has been based on this model.
Collection<Entity>	insert(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.
EntityEditModel.Settings	settings()
EntityEditModel.PersistTasks	tasks()
Entity	update()	Note: This method must be called on the UI thread in case a panel has been based on this model.
Collection<Entity>	update(Collection<Entity> entities)	Note: This method must be called on the UI thread in case a panel has been based on this model.

Field Details

PUBLISH_PERSISTENCE_EVENTS

static final PropertyValue<Boolean> PUBLISH_PERSISTENCE_EVENTS

Specifies whether edit models publish their insert, update and delete events to PersistenceEvents

• Value type: Boolean
• Default value: true

See Also:

• EntityEditModel.Settings.publishPersistenceEvents()

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

EntityEditor 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()

tasks

EntityEditModel.PersistTasks tasks()

Returns:

the EntityEditModel.PersistTasks

events

EntityEditModel.PersistEvents events()

Returns:

the EntityEditModel.PersistEvents

entities

Entities entities()

Returns:

the underlying domain entities

entityDefinition

EntityDefinition entityDefinition()

Returns:

the definition of the underlying entity

settings

EntityEditModel.Settings settings()

Returns:

the edit model settings

insert

Entity insert()

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity

Returns:

the inserted entity

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

• EntityEditModel.PersistEvents.beforeInsert()
• EntityEditModel.PersistEvents.afterInsert()
• EntityEditModel.Settings.insertEnabled()
• EntityEditor.validate(Entity)

insert

Collection<Entity> insert(Collection<Entity> entities)

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an insert on the given entities.

Parameters:

entities - the entities to insert

Returns:

a list containing the inserted entities

Throws:

DatabaseException - in case of a database exception

ValidationException - in case validation fails

IllegalStateException - in case inserting is not enabled

See Also:

• EntityEditModel.PersistEvents.beforeInsert()
• EntityEditModel.PersistEvents.afterInsert()
• EntityEditModel.Settings.insertEnabled()
• EntityEditor.validate(Entity)

update

Entity update()

Note: This method must be called on the UI thread in case a panel has been based on this model. Performs an update on the active entity

Returns:

the updated entity

Throws:

DatabaseException - in case of a database exception

EntityModifiedException - in case the entity has been modified since it was loaded

ValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

UpdateEntityException - in case the active entity is not modified

See Also:

• EntityEditModel.PersistEvents.beforeUpdate()
• EntityEditModel.PersistEvents.afterUpdate()
• EntityEditModel.Settings.updateEnabled()
• EntityEditor.validate(Entity)

update

Collection<Entity> update(Collection<Entity> entities)

Note: This method must be called on the UI thread in case a panel has been based on this model. Updates the given entities.

Parameters:

entities - the entities to update

Returns:

the updated entities

Throws:

DatabaseException - in case of a database exception

EntityModifiedException - in case an entity has been modified since it was loaded

ValidationException - in case validation fails

IllegalStateException - in case updating is not enabled

UpdateEntityException - in case any of the given entities are not modified

See Also:

• EntityEditModel.PersistEvents.beforeUpdate()
• EntityEditModel.PersistEvents.afterUpdate()
• EntityEditModel.Settings.updateEnabled()
• EntityEditor.validate(Entity)

delete

Entity delete()

Note: This method must be called on the UI thread in case a panel has been based on this model.

Returns:

the deleted entity

Throws:

DatabaseException - in case of a database exception

IllegalStateException - in case deleting is not enabled

See Also:

• EntityEditModel.PersistEvents.beforeDelete()
• EntityEditModel.PersistEvents.afterDelete()
• EntityEditModel.Settings.deleteEnabled()

delete

Collection<Entity> delete(Collection<Entity> entities)

Note: This method must be called on the UI thread in case a panel has been based on this model.

Parameters:

entities - the entities to delete

Returns:

the deleted entities

Throws:

DatabaseException - in case of a database exception

IllegalStateException - in case deleting is not enabled

See Also:

• EntityEditModel.PersistEvents.beforeDelete()
• EntityEditModel.PersistEvents.afterDelete()
• EntityEditModel.Settings.deleteEnabled()