Package org.iplass.mtp.entity

Class DeleteOption

java.lang.Object
org.iplass.mtp.entity.DeleteOption
public class DeleteOption extends Object
削除時のオプション。

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeleteOption()
     
    DeleteOption(boolean checkTimestamp)
    コンストラクタ。
    DeleteOption(boolean checkTimestamp, DeleteTargetVersion targetVersion)
    コンストラクタ。

  • Method Summary

    Modifier and Type
    Method
    Description
    DeleteTargetVersion
    getTargetVersion()
    Entityがバージョン管理されている場合に、削除対象とする対象バージョン。
    boolean
    isCheckLockedByUser()
    EntityManager.lockByUser(String, String)により、ユーザーによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうか。
    boolean
    isCheckTimestamp()
    タイムスタンプチェックを行うかどうか。
    boolean
    isNotifyListeners()
    削除時、 EntityEventListenerに通知するか否か
    boolean
    isPurge()
    ごみ箱に入れず、物理削除するかどうか。 trueの場合、物理削除。
    DeleteOption
    noCheckLockedByUser()
    ユーザーにより、当該Entityがロックされているか否かを確認せず削除処理する。
    DeleteOption
    noPurge()
    削除時、パージしないように設定。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
    void
    setCheckLockedByUser(boolean checkLockedByUser)
    EntityManager.lockByUser(String, String)により、ユーザーによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかをセット。 デフォルトtrue。 例えば、バックエンドのクリーンナッププログラムにてすでに無用なデータを削除するような場合、 当該オプションをfalseに指定して削除することにより、 バックエンドのプログラムはユーザーのロック状態によらず、データを削除することが可能となる。
    void
    setCheckTimestamp(boolean checkTimestamp)
    タイムスタンプのチェックを行うかどうかを設定。 trueの場合、チェックを行う。
    void
    setNotifyListeners(boolean notifyListeners)
    削除時、 EntityEventListenerに通知するか否かをセット デフォルトtrue
    void
    setPurge(boolean purge)
    ごみ箱に入れず、物理削除するかどうかを設定。 trueの場合、物理削除。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
    void
    setTargetVersion(DeleteTargetVersion targetVersion)
    Entityがバージョン管理されている場合に、削除対象とする対象バージョンを指定。 デフォルトはALL。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
    String
    toString()
     
    DeleteOption
    unnotifyListeners()
    削除時にEntityEventListenerに通知しないように設定。

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • DeleteOption

      public DeleteOption()

    • DeleteOption

      public DeleteOption(boolean checkTimestamp)
      コンストラクタ。
      Parameters:
      checkTimestamp - タイムスタンプチェック行う場合trueを指定

    • DeleteOption

      public DeleteOption(boolean checkTimestamp, DeleteTargetVersion targetVersion)
      コンストラクタ。
      Parameters:
      checkTimestamp - タイムスタンプチェック行う場合trueを指定
      targetVersion - バージョン管理している場合に対象バージョンを指定

  • Method Details

    • getTargetVersion

      public DeleteTargetVersion getTargetVersion()
      Entityがバージョン管理されている場合に、削除対象とする対象バージョン。
      Returns:

    • setTargetVersion

      public void setTargetVersion(DeleteTargetVersion targetVersion)
      Entityがバージョン管理されている場合に、削除対象とする対象バージョンを指定。 デフォルトはALL。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
      Parameters:
      targetVersion -

    • isPurge

      public boolean isPurge()
      ごみ箱に入れず、物理削除するかどうか。 trueの場合、物理削除。
      Returns:

    • setPurge

      public void setPurge(boolean purge)
      ごみ箱に入れず、物理削除するかどうかを設定。 trueの場合、物理削除。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
      Parameters:
      purge -

    • setCheckTimestamp

      public void setCheckTimestamp(boolean checkTimestamp)
      タイムスタンプのチェックを行うかどうかを設定。 trueの場合、チェックを行う。
      Parameters:
      checkTimestamp -

    • isCheckTimestamp

      public boolean isCheckTimestamp()
      タイムスタンプチェックを行うかどうか。
      Returns:
      trueの場合、タイムスタンプチェックありを示す

    • isCheckLockedByUser

      public boolean isCheckLockedByUser()
      EntityManager.lockByUser(String, String)により、ユーザーによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうか。
      Returns:
      trueの場合、別ユーザーによりロックされている場合は更新エラーとする。

    • setCheckLockedByUser

      public void setCheckLockedByUser(boolean checkLockedByUser)
      EntityManager.lockByUser(String, String)により、ユーザーによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかをセット。 デフォルトtrue。 例えば、バックエンドのクリーンナッププログラムにてすでに無用なデータを削除するような場合、 当該オプションをfalseに指定して削除することにより、 バックエンドのプログラムはユーザーのロック状態によらず、データを削除することが可能となる。
      Parameters:
      checkLockedByUser -

    • isNotifyListeners

      public boolean isNotifyListeners()
      削除時、 EntityEventListenerに通知するか否か
      Returns:

    • setNotifyListeners

      public void setNotifyListeners(boolean notifyListeners)
      削除時、 EntityEventListenerに通知するか否かをセット デフォルトtrue
      Parameters:
      notifyListeners -

    • noCheckLockedByUser

      public DeleteOption noCheckLockedByUser()
      ユーザーにより、当該Entityがロックされているか否かを確認せず削除処理する。
      Returns:

    • noPurge

      public DeleteOption noPurge()
      削除時、パージしないように設定。 DeleteTargetVersion.SPECIFICを指定した場合、purgeはfalseに設定できません。
      Returns:

    • unnotifyListeners

      public DeleteOption unnotifyListeners()
      削除時にEntityEventListenerに通知しないように設定。
      Returns:

    • toString

      public String toString()
      Overrides:
      toString in class Object