org.iplass.mtp.entity

クラス DeleteOption

java.lang.Object

org.iplass.mtp.entity.DeleteOption

public class DeleteOption
extends java.lang.Object

削除時のオプション。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DeleteOption()
DeleteOption(boolean checkTimestamp) コンストラクタ。
DeleteOption(boolean checkTimestamp, DeleteTargetVersion targetVersion) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
DeleteTargetVersion	getTargetVersion() Entityがバージョン管理されている場合に、削除対象とする対象バージョン。
boolean	isCheckLockedByUser() EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうか。
boolean	isCheckTimestamp() タイムスタンプチェックを行うかどうか。
boolean	isNotifyListeners() 削除時、 EntityEventListenerに通知するか否か
boolean	isPurge() ごみ箱に入れず、物理削除するかどうか。
DeleteOption	noCheckLockedByUser() ユーザにより、当該Entityがロックされているか否かを確認せず削除処理する。
DeleteOption	noPurge() 削除時、パージしないように設定
void	setCheckLockedByUser(boolean checkLockedByUser) EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかをセット。
void	setCheckTimestamp(boolean checkTimestamp) タイムスタンプのチェックを行うかどうかを設定。
void	setNotifyListeners(boolean notifyListeners) 削除時、 EntityEventListenerに通知するか否かをセット デフォルトtrue
void	setPurge(boolean purge) ごみ箱に入れず、物理削除するかどうかを設定。
void	setTargetVersion(DeleteTargetVersion targetVersion) Entityがバージョン管理されている場合に、削除対象とする対象バージョンを指定。
java.lang.String	toString()
DeleteOption	unnotifyListeners() 削除時にEntityEventListenerに通知しないように設定。

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

DeleteOption

public DeleteOption()

DeleteOption

public DeleteOption(boolean checkTimestamp)

コンストラクタ。

パラメータ:

checkTimestamp - タイムスタンプチェック行う場合trueを指定

DeleteOption

public DeleteOption(boolean checkTimestamp,
                    DeleteTargetVersion targetVersion)

コンストラクタ。

パラメータ:

checkTimestamp - タイムスタンプチェック行う場合trueを指定

targetVersion - バージョン管理している場合に対象バージョンを指定

メソッドの詳細

getTargetVersion

public DeleteTargetVersion getTargetVersion()

Entityがバージョン管理されている場合に、削除対象とする対象バージョン。

戻り値:

setTargetVersion

public void setTargetVersion(DeleteTargetVersion targetVersion)

Entityがバージョン管理されている場合に、削除対象とする対象バージョンを指定。 デフォルトはALL。

パラメータ:

targetVersion -

isPurge

public boolean isPurge()

ごみ箱に入れず、物理削除するかどうか。 trueの場合、物理削除。

戻り値:

setPurge

public void setPurge(boolean purge)

ごみ箱に入れず、物理削除するかどうかを設定。 trueの場合、物理削除。

パラメータ:

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

public DeleteOption noCheckLockedByUser()

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

戻り値:

noPurge

public DeleteOption noPurge()

削除時、パージしないように設定

戻り値:

unnotifyListeners

public DeleteOption unnotifyListeners()

削除時にEntityEventListenerに通知しないように設定。

戻り値:

toString

public java.lang.String toString()

オーバーライド:

toString クラス内 java.lang.Object