パッケージ org.iplass.mtp.entity

クラス UpdateOption

java.lang.Object
org.iplass.mtp.entity.UpdateOption
public class UpdateOption
extends java.lang.Object
Entity更新処理時に指定可能なオプションです。

  • コンストラクタの概要

    コンストラクタ 
    コンストラクタ 説明
    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.lang.String... updateProperty)
    更新対象のプロパティのリストを設定します。
    void setUpdateProperties​(java.util.List<java.lang.String> updateProperties)
    更新対象のプロパティのリストを設定します。
    void setWithValidation​(boolean withValidation)
    更新時、バリデーションを行うか否かをセットします。
    java.lang.String toString()  
    UpdateOption unnotifyListeners()
    更新時にEntityEventListenerに通知しないように設定します。
    UpdateOption withoutValidation()
    更新時にバリデーションを行わないように設定します。

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

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

  • コンストラクタの詳細

    • UpdateOption

      public UpdateOption()
      コンストラクタです。

    • UpdateOption

      public UpdateOption​(boolean checkTimestamp)
      コンストラクタです。
      パラメータ:
      checkTimestamp - 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックする

    • UpdateOption

      public UpdateOption​(boolean checkTimestamp, TargetVersion targetVersion)
      コンストラクタです。
      パラメータ:
      checkTimestamp - 更新時タイムスタンプチェックを行うかどうか。trueの場合チェックする
      targetVersion - バージョン管理する場合の更新対象

  • メソッドの詳細

    • allPropertyUpdateOption

      public static UpdateOption allPropertyUpdateOption​(java.lang.String defName, boolean checkTimestamp)
      全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。
      パラメータ:
      defName - Entityの定義名
      checkTimestamp - タイムスタンプによるチェックを行う場合true
      戻り値:
      UpdateOption

    • allPropertyUpdateOption

      public static UpdateOption allPropertyUpdateOption​(java.lang.String defName, boolean checkTimestamp, TargetVersion targetVersion)
      全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。
      パラメータ:
      defName - Entityの定義名
      checkTimestamp - タイムスタンプによるチェックを行う場合true
      targetVersion - バージョン管理時に更新対象のバージョンを指定するオプション
      戻り値:
      UpdateOption

    • allPropertyUpdateOption

      public static UpdateOption allPropertyUpdateOption​(java.lang.String defName, boolean checkTimestamp, boolean localized)
      全てのプロパティ（※更新不可項目を除く）を更新対象としてセットしたUpdateOptionを生成します。
      パラメータ:
      defName - Entityの定義名
      checkTimestamp - タイムスタンプによるチェックを行う場合true。
      localized - ローカライズフラグをon/offにするか否か。trueの場合、ローカライズを意識した形でupdate項目が取得される
      戻り値:
      UpdateOption

    • copy

      public UpdateOption copy()

    • getTargetVersion

      public TargetVersion getTargetVersion()
      戻り値:
      関連項目:
      setTargetVersion(TargetVersion)

    • setTargetVersion

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

    • isPurgeCompositionedEntity

      public boolean isPurgeCompositionedEntity()
      戻り値:
      関連項目:
      setPurgeCompositionedEntity(boolean)

    • setPurgeCompositionedEntity

      public void setPurgeCompositionedEntity​(boolean purgeCompositionedEntity)
      更新時、COMPOSITIONと定義されている参照先Entityが 参照から削除された場合の削除の方法を設定します。 trueの場合は物理削除します。 falseの場合は論理削除します。 デフォルトはtrueです。
      パラメータ:
      purgeCompositionedEntity -

    • setCheckTimestamp

      public void setCheckTimestamp​(boolean checkTimestamp)
      更新時タイムスタンプチェックを行う場合はtrueを設定します。 その際は、更新対象のEntityにupdateDate項目のセットが必要です。 デフォルトはtrueです。
      パラメータ:
      checkTimestamp -

    • isCheckTimestamp

      public boolean isCheckTimestamp()
      関連項目:
      setCheckTimestamp(boolean)

    • isForceUpdate

      public boolean isForceUpdate()
      関連項目:
      setForceUpdate(boolean)

    • setForceUpdate

      public void setForceUpdate​(boolean forceUpdate)
      変更項目が一つもなくとも、強制的に更新処理をする（結果、タイムスタンプ、更新者が更新される）かどうかを設定します。 デフォルトfalseです。
      パラメータ:
      forceUpdate -

    • isCheckLockedByUser

      public boolean isCheckLockedByUser()
      関連項目:
      setCheckLockedByUser(boolean)

    • setCheckLockedByUser

      public void setCheckLockedByUser​(boolean checkLockedByUser)
      EntityManager.lockByUser(String, String)により、ユーザーによってロックされている場合、 更新エラー(EntityLockedByUserException)とするかどうかを設定します。 デフォルトはtrueです。 ユーザーの画面操作によらない属性をバックエンドのプログラムから更新するような場合、 当該更新オプションをfalseに指定して更新することにより、 バックエンドのプログラムはユーザーのロック状態によらず、属性を更新することが可能となります。
      パラメータ:
      checkLockedByUser -

    • isWithValidation

      public boolean isWithValidation()
      関連項目:
      setWithValidation(boolean)

    • setWithValidation

      public void setWithValidation​(boolean withValidation)
      更新時、バリデーションを行うか否かをセットします。 デフォルトtrueです。
      パラメータ:
      withValidation -

    • isNotifyListeners

      public boolean isNotifyListeners()
      関連項目:
      setNotifyListeners(boolean)

    • setNotifyListeners

      public void setNotifyListeners​(boolean notifyListeners)
      更新時、 EntityEventListenerに通知するか否かをセットします。 デフォルトtrueです。
      パラメータ:
      notifyListeners -

    • isLocalized

      public boolean isLocalized()
      関連項目:
      setLocalized(boolean)

    • setLocalized

      public void setLocalized​(boolean localized)
      localized項目を更新対象とするか否かをセットします。
      パラメータ:
      localized -

    • getUpdateProperties

      public java.util.List<java.lang.String> getUpdateProperties()
      関連項目:
      setUpdateProperties(List)

    • setUpdateProperties

      public void setUpdateProperties​(java.util.List<java.lang.String> updateProperties)
      更新対象のプロパティのリストを設定します。
      パラメータ:
      updateProperties -

    • setUpdateProperties

      public void setUpdateProperties​(java.lang.String... updateProperty)
      更新対象のプロパティのリストを設定します。
      パラメータ:
      updateProperty -

    • add

      public UpdateOption add​(java.lang.String updateProperty)
      更新対象のプロパティを追加します。
      パラメータ:
      updateProperty - 更新対象のプロパティ名
      戻り値:
      UpdateOption自身

    • force

      public UpdateOption force()
      更新項目がなくとも、実際に更新処理実行します。結果、更新者、更新日が変更されます。
      戻り値:

    • noCheckLockedByUser

      public UpdateOption noCheckLockedByUser()
      ユーザーにより、当該Entityがロックされているか否かを確認せず更新処理します。
      戻り値:

    • withoutValidation

      public UpdateOption withoutValidation()
      更新時にバリデーションを行わないように設定します。
      戻り値:

    • unnotifyListeners

      public UpdateOption unnotifyListeners()
      更新時にEntityEventListenerに通知しないように設定します。
      戻り値:

    • noPurgeCompositionedEntity

      public UpdateOption noPurgeCompositionedEntity()
      更新時、COMPOSITIONと定義されている参照先Entityが参照から削除された場合に、パージしない（ゴミ箱に入る）ように設定します。
      戻り値:

    • localized

      public UpdateOption localized()
      localized=trueに設定します。
      戻り値:

    • toString

      public java.lang.String toString()
      オーバーライド:
      toString クラス内 java.lang.Object