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