Package org.iplass.mtp.entity
Class DeleteOption
java.lang.Object
org.iplass.mtp.entity.DeleteOption
public class DeleteOption
extends java.lang.Object
削除時のオプション。
-
Constructor Summary
Constructors Constructor Description DeleteOption()DeleteOption(boolean checkTimestamp)コンストラクタ。 -
Method Summary
Modifier and Type Method Description booleanisCheckLockedByUser()EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうか。booleanisCheckTimestamp()タイムスタンプチェックを行うかどうか。booleanisNotifyListeners()削除時、EntityEventListenerに通知するか否かbooleanisPurge()ごみ箱に入れず、物理削除するかどうか。 trueの場合、物理削除。DeleteOptionnoCheckLockedByUser()ユーザにより、当該Entityがロックされているか否かを確認せず削除処理する。DeleteOptionnoPurge()削除時、パージしないように設定voidsetCheckLockedByUser(boolean checkLockedByUser)EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかをセット。 デフォルトtrue。 例えば、バックエンドのクリーンナッププログラムにてすでに無用なデータを削除するような場合、 当該オプションをfalseに指定して削除することにより、 バックエンドのプログラムはユーザのロック状態によらず、データを削除することが可能となる。voidsetCheckTimestamp(boolean checkTimestamp)タイムスタンプのチェックを行うかどうかを設定。 trueの場合、チェックを行う。voidsetNotifyListeners(boolean notifyListeners)削除時、EntityEventListenerに通知するか否かをセット デフォルトtruevoidsetPurge(boolean purge)ごみ箱に入れず、物理削除するかどうかを設定。 trueの場合、物理削除。java.lang.StringtoString()DeleteOptionunnotifyListeners()削除時にEntityEventListenerに通知しないように設定。
-
Constructor Details
-
DeleteOption
public DeleteOption() -
DeleteOption
public DeleteOption(boolean checkTimestamp)コンストラクタ。- Parameters:
checkTimestamp- タイムスタンプチェック行う場合trueを指定
-
-
Method Details
-
isPurge
public boolean isPurge()ごみ箱に入れず、物理削除するかどうか。 trueの場合、物理削除。- Returns:
-
setPurge
public void setPurge(boolean purge)ごみ箱に入れず、物理削除するかどうかを設定。 trueの場合、物理削除。- 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
ユーザにより、当該Entityがロックされているか否かを確認せず削除処理する。- Returns:
-
noPurge
削除時、パージしないように設定- Returns:
-
unnotifyListeners
削除時にEntityEventListenerに通知しないように設定。- Returns:
-
toString
public java.lang.String toString()- Overrides:
toStringin classjava.lang.Object
-