パッケージ org.iplass.mtp.entity

インタフェース EntityEventListener

public interface EntityEventListener

Entityの登録、更新、削除、ロード、検索、検証時になんらかの処理を実行したい場合に利用します。 当該インタフェースを実装したクラスをEventListenerとして、 EntityDefinitionに定義することにより、各イベント発生時にメソッドが呼び出されます。

※注意

EntityManager#updateAll()、deleteAll()、bulkUpdate()などの一括更新処理では、リスナーは呼び出されません。
また、onLoadイベントは、load()もしくは、searchEntity()で呼び出され、search()では呼び出されません（Entityの形で返却されるわけではないため）。

また、update/delete時など更新前のEntityが存在する状態で、各通知メソッドが呼び出される際のentityインスタンスは、EntityManagerから各更新メソッド呼び出し時のEntityインスタンスが そのまま引き渡されたものです。そのため、oid以外のプロパティ項目を保持していない場合もあります。

関連項目:
JavaClassEventListenerDefinition

  • メソッドの詳細

    • afterDelete

      default void afterDelete​(Entity entity, EntityEventContext context)
      削除処理後に呼び出されます。
      パラメータ:
      entity -
      context -

    • afterInsert

      default void afterInsert​(Entity entity, EntityEventContext context)
      追加処理後に呼び出されます。
      パラメータ:
      entity -
      context -

    • afterUpdate

      default void afterUpdate​(Entity entity, EntityEventContext context)
      更新処理後に呼び出されます。
      パラメータ:
      entity -
      context -

    • beforeDelete

      default boolean beforeDelete​(Entity entity, EntityEventContext context)
      削除処理前に呼び出されます。 リターン値がfalseの場合、後続処理（実際の削除処理）を実行しません（例外は発生しません。処理が成功したかのように動作します）。
      パラメータ:
      entity -
      context -
      戻り値:

    • beforeInsert

      default boolean beforeInsert​(Entity entity, EntityEventContext context)
      追加処理前に呼び出されます。 リターン値がfalseの場合、後続処理（実際の追加処理）を実行しません（例外は発生しません。処理が成功したかのように動作します）。
      パラメータ:
      entity -
      context -
      戻り値:

    • beforeUpdate

      default boolean beforeUpdate​(Entity entity, EntityEventContext context)
      更新処理前に呼び出されます。 リターン値がfalseの場合、後続処理（実際の更新処理）を実行しません（例外は発生しません。処理が成功したかのように動作します）。
      パラメータ:
      entity -
      context -
      戻り値:

    • beforeValidate

      default void beforeValidate​(Entity entity, EntityEventContext context)
      検証処理前に呼び出されます。
      パラメータ:
      entity -
      context -

    • onLoad

      default void onLoad​(Entity entity)
      load、searchEntityでEntityの形で検索した際に呼び出されます。 1Entity単位の呼び出しなので、利用する場合、大量検索されてもよいように十分考慮する必要があります。
      パラメータ:
      entity -

    • afterRestore

      default void afterRestore​(Entity entity)
      ごみ箱から復旧した際に呼び出されます。
      パラメータ:
      entity -

    • afterPurge

      default void afterPurge​(Entity entity)
      削除処理時に、物理削除された場合、 もしくはごみ箱から完全に物理削除された際に呼び出されます。
      パラメータ:
      entity -