Package io.jmix.search.searching

Record Class IndexSearchRequestScope

java.lang.Object
java.lang.Record
io.jmix.search.searching.IndexSearchRequestScope
Record Components:
indexConfiguration - the configuration of the index relevant to the search request
fields - the set of fields that are included in the scope of the search request
public record IndexSearchRequestScope(IndexConfiguration indexConfiguration, Set<String> fields) extends Record
Represents the scope of an index search request, encapsulating the index configuration and a set of fields that is able for searching. This record is primarily used to define the boundaries of a search request within a particular index.

  • Constructor Details

    • IndexSearchRequestScope

      public IndexSearchRequestScope(IndexConfiguration indexConfiguration, Set<String> fields)
      Creates an instance of a IndexSearchRequestScope record class.
      Parameters:
      indexConfiguration - the value for the indexConfiguration record component
      fields - the value for the fields record component

  • Method Details

    • getFieldList

      public List<String> getFieldList()

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • indexConfiguration

      public IndexConfiguration indexConfiguration()
      Returns the value of the indexConfiguration record component.
      Returns:
      the value of the indexConfiguration record component

    • fields

      public Set<String> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component