Class LoadOption

java.lang.Object
org.iplass.mtp.entity.LoadOption

public class LoadOption extends Object
Entityのload時のオプションです。
  • Constructor Summary

    Constructors
    Constructor
    Description
    withReference = true, withMappedByReference = trueで設定するコンストラクタです。
    LoadOption(boolean withReference, boolean withMappedByReference)
    指定のオプションで、LoadOptionをnewします。
    LoadOption(String... loadReference)
    指定の参照プロパティのみをロードする形で、LoadOptionをnewします。 loadReferenceが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferenceが優先されます。
    LoadOption(List<String> loadReferences)
    指定の参照プロパティのみをロードする形で、LoadOptionをnewします。 loadReferencesが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferencesが優先されます。
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
     
    boolean
     
    boolean
     
    boolean
     
    boolean
     
    localized=trueに設定します。
    void
    setLoadReferences(List<String> loadReferences)
    Load時に指定の参照プロパティのみを読み込むように設定します。 loadReferencesが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferencesが優先されます。
    void
    setLocalized(boolean localized)
    localized項目をLoad対象とするか否かを設定します。
    void
    setNotifyListeners(boolean notifyListeners)
     
    void
    setVersioned(boolean versioned)
     
    void
    setWithMappedByReference(boolean withMappedByReference)
    Load時に被参照の参照プロパティも読み込むように設定します(withReference=trueとなっている前提の上で)。
    void
    setWithReference(boolean withReference)
    Load時に参照プロパティも読み込むように設定します。
     
    Load時に、EntityListenerに通知しないように設定します。
    参照先のEntityがバージョン管理されているEntityの場合、 参照先のEntityを保存時点のバージョンで取得します。 Load対象のEntity自体もバージョン管理されている場合は、 ロード対象Entityのversionまでを指定している場合に有効なフラグとなります。

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • LoadOption

      public LoadOption()
      withReference = true, withMappedByReference = trueで設定するコンストラクタです。
    • LoadOption

      public LoadOption(boolean withReference, boolean withMappedByReference)
      指定のオプションで、LoadOptionをnewします。
      Parameters:
      withReference - 参照プロパティも取得するように設定
      withMappedByReference - 被参照の参照プロパティも取得するように設定
    • LoadOption

      public LoadOption(List<String> loadReferences)
      指定の参照プロパティのみをロードする形で、LoadOptionをnewします。 loadReferencesが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferencesが優先されます。
      Parameters:
      loadReferences - ロードする参照プロパティ名のリスト
    • LoadOption

      public LoadOption(String... loadReference)
      指定の参照プロパティのみをロードする形で、LoadOptionをnewします。 loadReferenceが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferenceが優先されます。
      Parameters:
      loadReference - ロードする参照プロパティ名の可変引数
  • Method Details

    • isVersioned

      public boolean isVersioned()
    • setVersioned

      public void setVersioned(boolean versioned)
    • isNotifyListeners

      public boolean isNotifyListeners()
    • setNotifyListeners

      public void setNotifyListeners(boolean notifyListeners)
    • getLoadReferences

      public List<String> getLoadReferences()
    • setLoadReferences

      public void setLoadReferences(List<String> loadReferences)
      Load時に指定の参照プロパティのみを読み込むように設定します。 loadReferencesが指定されている場合は、 withReference、withMappedByReferenceの指定によらず、loadReferencesが優先されます。
      Parameters:
      loadReferences -
    • isWithReference

      public boolean isWithReference()
    • setWithReference

      public void setWithReference(boolean withReference)
      Load時に参照プロパティも読み込むように設定します。
      Parameters:
      withReference -
    • isWithMappedByReference

      public boolean isWithMappedByReference()
    • setWithMappedByReference

      public void setWithMappedByReference(boolean withMappedByReference)
      Load時に被参照の参照プロパティも読み込むように設定します(withReference=trueとなっている前提の上で)。
      Parameters:
      withMappedByReference -
    • isLocalized

      public boolean isLocalized()
    • setLocalized

      public void setLocalized(boolean localized)
      localized項目をLoad対象とするか否かを設定します。
      Parameters:
      localized -
    • localized

      public LoadOption localized()
      localized=trueに設定します。
      Returns:
    • unnotifyListeners

      public LoadOption unnotifyListeners()
      Load時に、EntityListenerに通知しないように設定します。
      Returns:
    • versioned

      public LoadOption versioned()
      参照先のEntityがバージョン管理されているEntityの場合、 参照先のEntityを保存時点のバージョンで取得します。 Load対象のEntity自体もバージョン管理されている場合は、 ロード対象Entityのversionまでを指定している場合に有効なフラグとなります。
      Returns:
    • toString

      public String toString()
      Overrides:
      toString in class Object