public class UpdateOption
extends java.lang.Object
コンストラクタと説明 |
---|
UpdateOption()
コンストラクタです。
|
UpdateOption(boolean checkTimestamp)
コンストラクタです。
|
UpdateOption(boolean checkTimestamp,
TargetVersion targetVersion)
コンストラクタです。
|
修飾子とタイプ | メソッドと説明 |
---|---|
UpdateOption |
add(java.lang.String updateProperty)
更新対象のプロパティを追加します。
|
static UpdateOption |
allPropertyUpdateOption(java.lang.String defName,
boolean checkTimestamp)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。
|
static UpdateOption |
allPropertyUpdateOption(java.lang.String defName,
boolean checkTimestamp,
boolean localized)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。
|
static UpdateOption |
allPropertyUpdateOption(java.lang.String defName,
boolean checkTimestamp,
TargetVersion targetVersion)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。
|
UpdateOption |
copy() |
UpdateOption |
force()
更新項目がなくとも、実際に更新処理実行します。
|
TargetVersion |
getTargetVersion() |
java.util.List<java.lang.String> |
getUpdateProperties() |
boolean |
isCheckLockedByUser() |
boolean |
isCheckTimestamp() |
boolean |
isForceUpdate() |
boolean |
isLocalized() |
boolean |
isNotifyListeners() |
boolean |
isPurgeCompositionedEntity() |
boolean |
isWithValidation() |
UpdateOption |
localized()
localized=trueに設定します。
|
UpdateOption |
noCheckLockedByUser()
ユーザにより、当該Entityがロックされているか否かを確認せず更新処理します。
|
UpdateOption |
noPurgeCompositionedEntity()
更新時、COMPOSITIONと定義されている参照先Entityが参照から削除された場合に、パージしない(ゴミ箱に入る)ように設定します。
|
void |
setCheckLockedByUser(boolean checkLockedByUser)
EntityManager.lockByUser(String, String) により、ユーザによってロックされている場合、
更新エラー(EntityLockedByUserException)とするかどうかを設定します。 |
void |
setCheckTimestamp(boolean checkTimestamp)
更新時タイムスタンプチェックを行う場合はtrueを設定します。
|
void |
setForceUpdate(boolean forceUpdate)
変更項目が一つもなくとも、強制的に更新処理をする(結果、タイムスタンプ、更新者が更新される)かどうかを設定します。
|
void |
setLocalized(boolean localized)
localized項目を更新対象とするか否かをセットします。
|
void |
setNotifyListeners(boolean notifyListeners)
更新時、
EntityEventListener に通知するか否かをセットします。 |
void |
setPurgeCompositionedEntity(boolean purgeCompositionedEntity)
更新時、COMPOSITIONと定義されている参照先Entityが
参照から削除された場合の削除の方法を設定します。
|
void |
setTargetVersion(TargetVersion targetVersion)
バージョン管理時、更新対象のバージョンを指定します。
|
void |
setUpdateProperties(java.util.List<java.lang.String> updateProperties)
更新対象のプロパティのリストを設定します。
|
void |
setUpdateProperties(java.lang.String... updateProperty)
更新対象のプロパティのリストを設定します。
|
void |
setWithValidation(boolean withValidation)
更新時、バリデーションを行うか否かをセットします。
|
java.lang.String |
toString() |
UpdateOption |
unnotifyListeners()
更新時に
EntityEventListener に通知しないように設定します。 |
UpdateOption |
withoutValidation()
更新時にバリデーションを行わないように設定します。
|
public UpdateOption()
public UpdateOption(boolean checkTimestamp)
checkTimestamp
- 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックするpublic UpdateOption(boolean checkTimestamp, TargetVersion targetVersion)
checkTimestamp
- 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックするtargetVersion
- バージョン管理する場合の更新対象public static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp)
defName
- Entityの定義名checkTimestamp
- タイムスタンプによるチェックを行う場合truepublic static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, TargetVersion targetVersion)
defName
- Entityの定義名checkTimestamp
- タイムスタンプによるチェックを行う場合truetargetVersion
- バージョン管理時に更新対象のバージョンを指定するオプションpublic static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, boolean localized)
defName
- Entityの定義名checkTimestamp
- タイムスタンプによるチェックを行う場合true。localized
- ローカライズフラグをon/offにするか否か。trueの場合、ローカライズを意識した形でupdate項目が取得されるpublic UpdateOption copy()
public TargetVersion getTargetVersion()
setTargetVersion(TargetVersion)
public void setTargetVersion(TargetVersion targetVersion)
targetVersion
- public boolean isPurgeCompositionedEntity()
setPurgeCompositionedEntity(boolean)
public void setPurgeCompositionedEntity(boolean purgeCompositionedEntity)
purgeCompositionedEntity
- public void setCheckTimestamp(boolean checkTimestamp)
checkTimestamp
- public boolean isCheckTimestamp()
public boolean isForceUpdate()
setForceUpdate(boolean)
public void setForceUpdate(boolean forceUpdate)
forceUpdate
- public boolean isCheckLockedByUser()
public void setCheckLockedByUser(boolean checkLockedByUser)
EntityManager.lockByUser(String, String)
により、ユーザによってロックされている場合、
更新エラー(EntityLockedByUserException)とするかどうかを設定します。
デフォルトはtrueです。
ユーザの画面操作によらない属性をバックエンドのプログラムから更新するような場合、
当該更新オプションをfalseに指定して更新することにより、
バックエンドのプログラムはユーザのロック状態によらず、属性を更新することが可能となります。checkLockedByUser
- public boolean isWithValidation()
public void setWithValidation(boolean withValidation)
withValidation
- public boolean isNotifyListeners()
public void setNotifyListeners(boolean notifyListeners)
EntityEventListener
に通知するか否かをセットします。
デフォルトtrueです。notifyListeners
- public boolean isLocalized()
setLocalized(boolean)
public void setLocalized(boolean localized)
localized
- public java.util.List<java.lang.String> getUpdateProperties()
public void setUpdateProperties(java.util.List<java.lang.String> updateProperties)
updateProperties
- public void setUpdateProperties(java.lang.String... updateProperty)
updateProperty
- public UpdateOption add(java.lang.String updateProperty)
updateProperty
- 更新対象のプロパティ名public UpdateOption force()
public UpdateOption noCheckLockedByUser()
public UpdateOption withoutValidation()
public UpdateOption unnotifyListeners()
EntityEventListener
に通知しないように設定します。public UpdateOption noPurgeCompositionedEntity()
public UpdateOption localized()
public java.lang.String toString()
toString
クラス内 java.lang.Object