public interface EntityEventListener
Entityの登録、更新、削除、ロード、検索、検証時になんらかの処理を実行したい場合に利用します。 当該インタフェースを実装したクラスをEventListenerとして、 EntityDefinitionに定義することにより、各イベント発生時にメソッドが呼び出されます。
EntityManager#updateAll()、deleteAll()、bulkUpdate()などの一括更新処理では、リスナーは呼び出されません。
また、onLoadイベントは、load()もしくは、searchEntity()で呼び出され、search()では呼び出されません(Entityの形で返却されるわけではないため)。
また、update/delete時など更新前のEntityが存在する状態で、各通知メソッドが呼び出される際のentityインスタンスは、EntityManagerから各更新メソッド呼び出し時のEntityインスタンスが そのまま引き渡されたものです。そのため、oid以外のプロパティ項目を保持していない場合もあります。
修飾子とタイプ | メソッドと説明 |
---|---|
default void |
afterDelete(Entity entity,
EntityEventContext context)
削除処理後に呼び出されます。
|
default void |
afterInsert(Entity entity,
EntityEventContext context)
追加処理後に呼び出されます。
|
default void |
afterPurge(Entity entity)
削除処理時に、物理削除された場合、
もしくはごみ箱から完全に物理削除された際に呼び出されます。
|
default void |
afterRestore(Entity entity)
ごみ箱から復旧した際に呼び出されます。
|
default void |
afterUpdate(Entity entity,
EntityEventContext context)
更新処理後に呼び出されます。
|
default boolean |
beforeDelete(Entity entity,
EntityEventContext context)
削除処理前に呼び出されます。
|
default boolean |
beforeInsert(Entity entity,
EntityEventContext context)
追加処理前に呼び出されます。
|
default boolean |
beforeUpdate(Entity entity,
EntityEventContext context)
更新処理前に呼び出されます。
|
default void |
beforeValidate(Entity entity,
EntityEventContext context)
検証処理前に呼び出されます。
|
default void |
onLoad(Entity entity)
load、searchEntityでEntityの形で検索した際に呼び出されます。
|
default void afterDelete(Entity entity, EntityEventContext context)
entity
- context
- default void afterInsert(Entity entity, EntityEventContext context)
entity
- context
- default void afterUpdate(Entity entity, EntityEventContext context)
entity
- context
- default boolean beforeDelete(Entity entity, EntityEventContext context)
entity
- context
- default boolean beforeInsert(Entity entity, EntityEventContext context)
entity
- context
- default boolean beforeUpdate(Entity entity, EntityEventContext context)
entity
- context
- default void beforeValidate(Entity entity, EntityEventContext context)
entity
- context
- default void onLoad(Entity entity)
entity
- default void afterRestore(Entity entity)
entity
- default void afterPurge(Entity entity)
entity
-