Package org.iplass.mtp.entity
Class UpdateOption
- java.lang.Object
-
- org.iplass.mtp.entity.UpdateOption
-
public class UpdateOption extends java.lang.ObjectEntity更新処理時に指定可能なオプションです。
-
-
Constructor Summary
Constructors Constructor Description UpdateOption()コンストラクタです。UpdateOption(boolean checkTimestamp)コンストラクタです。UpdateOption(boolean checkTimestamp, TargetVersion targetVersion)コンストラクタです。
-
Method Summary
Modifier and Type Method Description UpdateOptionadd(java.lang.String updateProperty)更新対象のプロパティを追加します。static UpdateOptionallPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp)全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。static UpdateOptionallPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, boolean localized)全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。static UpdateOptionallPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, TargetVersion targetVersion)全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。UpdateOptioncopy()UpdateOptionforce()更新項目がなくとも、実際に更新処理実行します。結果、更新者、更新日が変更されます。TargetVersiongetTargetVersion()java.util.List<java.lang.String>getUpdateProperties()booleanisCheckLockedByUser()booleanisCheckTimestamp()booleanisForceUpdate()booleanisLocalized()booleanisNotifyListeners()booleanisPurgeCompositionedEntity()booleanisWithValidation()UpdateOptionlocalized()localized=trueに設定します。UpdateOptionnoCheckLockedByUser()ユーザにより、当該Entityがロックされているか否かを確認せず更新処理します。UpdateOptionnoPurgeCompositionedEntity()更新時、COMPOSITIONと定義されている参照先Entityが参照から削除された場合に、パージしない(ゴミ箱に入る)ように設定します。voidsetCheckLockedByUser(boolean checkLockedByUser)EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかを設定します。 デフォルトはtrueです。 ユーザの画面操作によらない属性をバックエンドのプログラムから更新するような場合、 当該更新オプションをfalseに指定して更新することにより、 バックエンドのプログラムはユーザのロック状態によらず、属性を更新することが可能となります。voidsetCheckTimestamp(boolean checkTimestamp)更新時タイムスタンプチェックを行う場合はtrueを設定します。 その際は、更新対象のEntityにupdateDate項目のセットが必要です。 デフォルトはtrueです。voidsetForceUpdate(boolean forceUpdate)変更項目が一つもなくとも、強制的に更新処理をする(結果、タイムスタンプ、更新者が更新される)かどうかを設定します。 デフォルトfalseです。voidsetLocalized(boolean localized)localized項目を更新対象とするか否かをセットします。voidsetNotifyListeners(boolean notifyListeners)更新時、EntityEventListenerに通知するか否かをセットします。 デフォルトtrueです。voidsetPurgeCompositionedEntity(boolean purgeCompositionedEntity)更新時、COMPOSITIONと定義されている参照先Entityが 参照から削除された場合の削除の方法を設定します。 trueの場合は物理削除します。 falseの場合は論理削除します。 デフォルトはtrueです。voidsetTargetVersion(TargetVersion targetVersion)バージョン管理時、更新対象のバージョンを指定します。 デフォルト値はTargetVersion.CURRENT_VALIDです。 TargetVersion.SPECIFICの場合は、更新対象のEntityにversion項目のセットが必要です。voidsetUpdateProperties(java.lang.String... updateProperty)更新対象のプロパティのリストを設定します。voidsetUpdateProperties(java.util.List<java.lang.String> updateProperties)更新対象のプロパティのリストを設定します。voidsetWithValidation(boolean withValidation)更新時、バリデーションを行うか否かをセットします。 デフォルトtrueです。java.lang.StringtoString()UpdateOptionunnotifyListeners()更新時にEntityEventListenerに通知しないように設定します。UpdateOptionwithoutValidation()更新時にバリデーションを行わないように設定します。
-
-
-
Constructor Detail
-
UpdateOption
public UpdateOption()
コンストラクタです。
-
UpdateOption
public UpdateOption(boolean checkTimestamp)
コンストラクタです。- Parameters:
checkTimestamp- 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックする
-
UpdateOption
public UpdateOption(boolean checkTimestamp, TargetVersion targetVersion)コンストラクタです。- Parameters:
checkTimestamp- 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックするtargetVersion- バージョン管理する場合の更新対象
-
-
Method Detail
-
allPropertyUpdateOption
public static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。- Parameters:
defName- Entityの定義名checkTimestamp- タイムスタンプによるチェックを行う場合true- Returns:
- UpdateOption
-
allPropertyUpdateOption
public static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, TargetVersion targetVersion)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。- Parameters:
defName- Entityの定義名checkTimestamp- タイムスタンプによるチェックを行う場合truetargetVersion- バージョン管理時に更新対象のバージョンを指定するオプション- Returns:
- UpdateOption
-
allPropertyUpdateOption
public static UpdateOption allPropertyUpdateOption(java.lang.String defName, boolean checkTimestamp, boolean localized)
全てのプロパティ(※更新不可項目を除く)を更新対象としてセットしたUpdateOptionを生成します。- Parameters:
defName- Entityの定義名checkTimestamp- タイムスタンプによるチェックを行う場合true。localized- ローカライズフラグをon/offにするか否か。trueの場合、ローカライズを意識した形でupdate項目が取得される- Returns:
- UpdateOption
-
copy
public UpdateOption copy()
-
getTargetVersion
public TargetVersion getTargetVersion()
- Returns:
- See Also:
setTargetVersion(TargetVersion)
-
setTargetVersion
public void setTargetVersion(TargetVersion targetVersion)
バージョン管理時、更新対象のバージョンを指定します。 デフォルト値はTargetVersion.CURRENT_VALIDです。 TargetVersion.SPECIFICの場合は、更新対象のEntityにversion項目のセットが必要です。- Parameters:
targetVersion-
-
isPurgeCompositionedEntity
public boolean isPurgeCompositionedEntity()
- Returns:
- See Also:
setPurgeCompositionedEntity(boolean)
-
setPurgeCompositionedEntity
public void setPurgeCompositionedEntity(boolean purgeCompositionedEntity)
更新時、COMPOSITIONと定義されている参照先Entityが 参照から削除された場合の削除の方法を設定します。 trueの場合は物理削除します。 falseの場合は論理削除します。 デフォルトはtrueです。- Parameters:
purgeCompositionedEntity-
-
setCheckTimestamp
public void setCheckTimestamp(boolean checkTimestamp)
更新時タイムスタンプチェックを行う場合はtrueを設定します。 その際は、更新対象のEntityにupdateDate項目のセットが必要です。 デフォルトはtrueです。- Parameters:
checkTimestamp-
-
isCheckTimestamp
public boolean isCheckTimestamp()
- See Also:
setCheckTimestamp(boolean)
-
isForceUpdate
public boolean isForceUpdate()
- See Also:
setForceUpdate(boolean)
-
setForceUpdate
public void setForceUpdate(boolean forceUpdate)
変更項目が一つもなくとも、強制的に更新処理をする(結果、タイムスタンプ、更新者が更新される)かどうかを設定します。 デフォルトfalseです。- Parameters:
forceUpdate-
-
isCheckLockedByUser
public boolean isCheckLockedByUser()
- See Also:
setCheckLockedByUser(boolean)
-
setCheckLockedByUser
public void setCheckLockedByUser(boolean checkLockedByUser)
EntityManager.lockByUser(String, String)により、ユーザによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかを設定します。 デフォルトはtrueです。 ユーザの画面操作によらない属性をバックエンドのプログラムから更新するような場合、 当該更新オプションをfalseに指定して更新することにより、 バックエンドのプログラムはユーザのロック状態によらず、属性を更新することが可能となります。- Parameters:
checkLockedByUser-
-
isWithValidation
public boolean isWithValidation()
- See Also:
setWithValidation(boolean)
-
setWithValidation
public void setWithValidation(boolean withValidation)
更新時、バリデーションを行うか否かをセットします。 デフォルトtrueです。- Parameters:
withValidation-
-
isNotifyListeners
public boolean isNotifyListeners()
- See Also:
setNotifyListeners(boolean)
-
setNotifyListeners
public void setNotifyListeners(boolean notifyListeners)
更新時、EntityEventListenerに通知するか否かをセットします。 デフォルトtrueです。- Parameters:
notifyListeners-
-
isLocalized
public boolean isLocalized()
- See Also:
setLocalized(boolean)
-
setLocalized
public void setLocalized(boolean localized)
localized項目を更新対象とするか否かをセットします。- Parameters:
localized-
-
getUpdateProperties
public java.util.List<java.lang.String> getUpdateProperties()
- See Also:
setUpdateProperties(List)
-
setUpdateProperties
public void setUpdateProperties(java.util.List<java.lang.String> updateProperties)
更新対象のプロパティのリストを設定します。- Parameters:
updateProperties-
-
setUpdateProperties
public void setUpdateProperties(java.lang.String... updateProperty)
更新対象のプロパティのリストを設定します。- Parameters:
updateProperty-
-
add
public UpdateOption add(java.lang.String updateProperty)
更新対象のプロパティを追加します。- Parameters:
updateProperty- 更新対象のプロパティ名- Returns:
- UpdateOption自身
-
force
public UpdateOption force()
更新項目がなくとも、実際に更新処理実行します。結果、更新者、更新日が変更されます。- Returns:
-
noCheckLockedByUser
public UpdateOption noCheckLockedByUser()
ユーザにより、当該Entityがロックされているか否かを確認せず更新処理します。- Returns:
-
withoutValidation
public UpdateOption withoutValidation()
更新時にバリデーションを行わないように設定します。- Returns:
-
unnotifyListeners
public UpdateOption unnotifyListeners()
更新時にEntityEventListenerに通知しないように設定します。- Returns:
-
noPurgeCompositionedEntity
public UpdateOption noPurgeCompositionedEntity()
更新時、COMPOSITIONと定義されている参照先Entityが参照から削除された場合に、パージしない(ゴミ箱に入る)ように設定します。- Returns:
-
localized
public UpdateOption localized()
localized=trueに設定します。- Returns:
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-