java.lang.Object

org.iplass.mtp.entity.UpdateOption

public class UpdateOption extends Object

Entity更新処理時に指定可能なオプションです。

Constructor Summary

Constructors

Constructor

Description

UpdateOption()

コンストラクタです。

UpdateOption(boolean checkTimestamp)

コンストラクタです。

UpdateOption(boolean checkTimestamp, TargetVersion targetVersion)

コンストラクタです。
Method Summary

Modifier and Type

Method

Description

UpdateOption

add(String updateProperty)

更新対象のプロパティを追加します。

static UpdateOption

allPropertyUpdateOption(String defName, boolean checkTimestamp)

全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。

static UpdateOption

allPropertyUpdateOption(String defName, boolean checkTimestamp, boolean localized)

全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。

static UpdateOption

allPropertyUpdateOption(String defName, boolean checkTimestamp, TargetVersion targetVersion)

全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。

UpdateOption

copy()

UpdateOption

force()

更新項目がなくとも、実際に更新処理実行します。結果、更新者、更新日が変更されます。

TargetVersion

getTargetVersion()

List<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)とするかどうかを設定します。デフォルトはtrueです。ユーザーの画面操作によらない属性をバックエンドのプログラムから更新するような場合、当該更新オプションをfalseに指定して更新することにより、バックエンドのプログラムはユーザーのロック状態によらず、属性を更新することが可能となります。

void

setCheckTimestamp(boolean checkTimestamp)

更新時タイムスタンプチェックを行う場合はtrueを設定します。その際は、更新対象のEntityにupdateDate項目のセットが必要です。デフォルトはtrueです。

void

setForceUpdate(boolean forceUpdate)

変更項目が一つもなくとも、強制的に更新処理をする（結果、タイムスタンプ、更新者が更新される）かどうかを設定します。デフォルトfalseです。

void

setLocalized(boolean localized)

localized項目を更新対象とするか否かをセットします。

void

setNotifyListeners(boolean notifyListeners)

更新時、 EntityEventListenerに通知するか否かをセットします。デフォルトtrueです。

void

setPurgeCompositionedEntity(boolean purgeCompositionedEntity)

更新時、COMPOSITIONと定義されている参照先Entityが参照から削除された場合の削除の方法を設定します。 trueの場合は物理削除します。 falseの場合は論理削除します。デフォルトはtrueです。

void

setTargetVersion(TargetVersion targetVersion)

バージョン管理時、更新対象のバージョンを指定します。デフォルト値はTargetVersion.CURRENT_VALIDです。
TargetVersion.SPECIFICの場合は、更新対象のEntityにversion項目のセットが必要です。
TargetVersion.NEWの場合、updatePropertiesに未指定の値はベースとなるEntityの値がコピーされます。ベースとなるEntityは、更新対象のEntityにversionが指定された場合はそのバージョンがベースになります。versionが未指定の場合は、現状の有効なバージョンがベースになります。

void

setUpdateProperties(String... updateProperty)

更新対象のプロパティのリストを設定します。

void

setUpdateProperties(List<String> updateProperties)

更新対象のプロパティのリストを設定します。

void

setWithValidation(boolean withValidation)

更新時、バリデーションを行うか否かをセットします。デフォルトtrueです。

String

toString()

UpdateOption

unnotifyListeners()

更新時にEntityEventListenerに通知しないように設定します。

UpdateOption

withoutValidation()

更新時にバリデーションを行わないように設定します。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- UpdateOption
  
  public UpdateOption()
  
  コンストラクタです。
- UpdateOption
  
  public UpdateOption(boolean checkTimestamp)
  
  コンストラクタです。
  
  Parameters:
  
  checkTimestamp - 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックする
- UpdateOption
  
  public UpdateOption(boolean checkTimestamp, TargetVersion targetVersion)
  
  コンストラクタです。
  
  Parameters:
  
  checkTimestamp - 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックする
  
  targetVersion - バージョン管理する場合の更新対象
Method Details
- allPropertyUpdateOption
  
  public static UpdateOption allPropertyUpdateOption(String defName, boolean checkTimestamp)
  
  全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。
  
  Parameters:
  
  defName - Entityの定義名
  
  checkTimestamp - タイムスタンプによるチェックを行う場合true
  
  Returns:
  
  UpdateOption
- allPropertyUpdateOption
  
  public static UpdateOption allPropertyUpdateOption(String defName, boolean checkTimestamp, TargetVersion targetVersion)
  
  全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。
  
  Parameters:
  
  defName - Entityの定義名
  
  checkTimestamp - タイムスタンプによるチェックを行う場合true
  
  targetVersion - バージョン管理時に更新対象のバージョンを指定するオプション
  
  Returns:
  
  UpdateOption
- allPropertyUpdateOption
  
  public static UpdateOption allPropertyUpdateOption(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項目のセットが必要です。
  TargetVersion.NEWの場合、updatePropertiesに未指定の値はベースとなるEntityの値がコピーされます。ベースとなるEntityは、更新対象のEntityにversionが指定された場合はそのバージョンがベースになります。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 List<String> getUpdateProperties()
  See Also:
  
  setUpdateProperties(List)
- setUpdateProperties
  
  public void setUpdateProperties(List<String> updateProperties)
  
  更新対象のプロパティのリストを設定します。
  
  Parameters:
  
  updateProperties -
- setUpdateProperties
  
  public void setUpdateProperties(String... updateProperty)
  
  更新対象のプロパティのリストを設定します。
  
  Parameters:
  
  updateProperty -
- add
  
  public UpdateOption add(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 String toString()
  
  Overrides:
  
  toString in class Object

Class UpdateOption

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

UpdateOption

UpdateOption

UpdateOption

Method Details

allPropertyUpdateOption

allPropertyUpdateOption

allPropertyUpdateOption

copy

getTargetVersion

setTargetVersion

isPurgeCompositionedEntity

setPurgeCompositionedEntity

setCheckTimestamp

isCheckTimestamp

isForceUpdate

setForceUpdate

isCheckLockedByUser

setCheckLockedByUser

isWithValidation

setWithValidation

isNotifyListeners

setNotifyListeners

isLocalized

setLocalized

getUpdateProperties

setUpdateProperties

setUpdateProperties

add

force

noCheckLockedByUser

withoutValidation

unnotifyListeners

noPurgeCompositionedEntity

localized

toString