Module is.codion.framework.model

Package is.codion.framework.model

Interface PersistenceEvents

public interface PersistenceEvents

A framework-wide event bus for entity persistence, keyed per EntityType.

Instances are static and shared per entity type (see persistenceEvents(EntityType)). The PersistenceEvents.Inserted, PersistenceEvents.Updated and PersistenceEvents.Deleted events extend Consumer, so any code - not just the editor - may publish persistence events.

The bus is shared by the whole JVM and knows nothing of connections: a listener hears the events of every editor in the JVM, whichever connection persisted the entities. This assumes one database per JVM, where two connections to it see each other's changes, as they should. Where one JVM connects to several databases with the same entity types, opt out on either side: an editor via EntityEditor.Settings.publishPersistenceEvents(), or EntityEditor.PUBLISH_PERSISTENCE_EVENTS for all, a model listening via its persistenceAware() builder option, see EntityComboBoxModel.PERSISTENCE_AWARE and EntitySearchModel.PERSISTENCE_AWARE.

See Also:

• EntityEditor.PUBLISH_PERSISTENCE_EVENTS
• EntityEditor.Settings.publishPersistenceEvents()
• persistenceEvents(EntityType)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PersistenceEvents.Deleted	Notified on delete.
static interface	PersistenceEvents.Inserted	Notified on insert.
static interface	PersistenceEvents.Updated	Notified on update.

Method Summary

Modifier and Type	Method	Description
PersistenceEvents.Deleted	deleted()	Returns a PersistenceEvents.Deleted, notified each time entities are deleted.
PersistenceEvents.Inserted	inserted()	Returns an PersistenceEvents.Inserted, notified each time entities are inserted.
Observer<Collection<Entity>>	persisted()	Notified when entities have been persisted, that is, inserted, updated or deleted.
static PersistenceEvents	persistenceEvents(EntityType entityType)
PersistenceEvents.Updated	updated()	Returns an PersistenceEvents.Updated, notified each time entities are updated.

Method Details

persistenceEvents

static PersistenceEvents persistenceEvents(EntityType entityType)

Parameters:

entityType - the entity type

Returns:

the central PersistenceEvents instance for the given entity type

inserted

PersistenceEvents.Inserted inserted()

Returns an PersistenceEvents.Inserted, notified each time entities are inserted.

Returns:

the PersistenceEvents.Inserted instance

updated

PersistenceEvents.Updated updated()

Returns an PersistenceEvents.Updated, notified each time entities are updated.

Returns:

the PersistenceEvents.Updated instance

deleted

PersistenceEvents.Deleted deleted()

Returns a PersistenceEvents.Deleted, notified each time entities are deleted.

Returns:

the PersistenceEvents.Deleted instance

persisted

Observer<Collection<Entity>> persisted()

Notified when entities have been persisted, that is, inserted, updated or deleted.

See Also:

• inserted()
• updated()
• deleted()