Record Class EffectiveLookupConfig

java.lang.Object
java.lang.Record
io.jmix.flowui.component.factory.EffectiveLookupConfig
Record Components:
componentType - resolved component intent, or null if no @LookupField applies
fieldLevel - true if the component config came from a field-level annotation
actions - resolved action ids (field annotation, then property, then class annotation)
itemsMode - items behavior for a DROPDOWN; ignored for VIEW
query - explicit JPQL for EffectiveLookupConfig.ItemsMode.QUERY
searchStringFormat - search-string format for EffectiveLookupConfig.ItemsMode.QUERY
escapeValueForLike - escape flag for EffectiveLookupConfig.ItemsMode.QUERY
fetchPlanName - optional fetch plan name for lazy items

public record EffectiveLookupConfig(@Nullable LookupType componentType, boolean fieldLevel, List<String> actions, EffectiveLookupConfig.ItemsMode itemsMode, @Nullable String query, @Nullable String searchStringFormat, boolean escapeValueForLike, @Nullable String fetchPlanName) extends Record
The effective, precedence-resolved @LookupField configuration for one entity reference. Produced by LookupFieldSupport; consumed by EntityFieldCreationSupport (live component) and ComponentXmlFactory (XML descriptor).
  • Constructor Details

    • EffectiveLookupConfig

      public EffectiveLookupConfig(@Nullable LookupType componentType, boolean fieldLevel, List<String> actions, EffectiveLookupConfig.ItemsMode itemsMode, @Nullable String query, @Nullable String searchStringFormat, boolean escapeValueForLike, @Nullable String fetchPlanName)
      Creates an instance of a EffectiveLookupConfig record class.
      Parameters:
      componentType - the value for the componentType record component
      fieldLevel - the value for the fieldLevel record component
      actions - the value for the actions record component
      itemsMode - the value for the itemsMode record component
      query - the value for the query record component
      searchStringFormat - the value for the searchStringFormat record component
      escapeValueForLike - the value for the escapeValueForLike record component
      fetchPlanName - the value for the fetchPlanName record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • componentType

      public @Nullable LookupType componentType()
      Returns the value of the componentType record component.
      Returns:
      the value of the componentType record component
    • fieldLevel

      public boolean fieldLevel()
      Returns the value of the fieldLevel record component.
      Returns:
      the value of the fieldLevel record component
    • actions

      public List<String> actions()
      Returns the value of the actions record component.
      Returns:
      the value of the actions record component
    • itemsMode

      public EffectiveLookupConfig.ItemsMode itemsMode()
      Returns the value of the itemsMode record component.
      Returns:
      the value of the itemsMode record component
    • query

      public @Nullable String query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component
    • searchStringFormat

      public @Nullable String searchStringFormat()
      Returns the value of the searchStringFormat record component.
      Returns:
      the value of the searchStringFormat record component
    • escapeValueForLike

      public boolean escapeValueForLike()
      Returns the value of the escapeValueForLike record component.
      Returns:
      the value of the escapeValueForLike record component
    • fetchPlanName

      public @Nullable String fetchPlanName()
      Returns the value of the fetchPlanName record component.
      Returns:
      the value of the fetchPlanName record component