Package io.jmix.restds.impl

Record Class RestInvoker.LoadListParams

java.lang.Object
java.lang.Record
io.jmix.restds.impl.RestInvoker.LoadListParams
Record Components:
additionalParams - parameters added to the query string of a GET request, or as fields of the JSON body when filter is set and the search endpoint is used. Names that the store sets itself (fetchPlan, limit, offset, sort, filter, returnCount) and null values are not allowed.
Enclosing class:
RestInvoker
public static record RestInvoker.LoadListParams(String entityName, int limit, int offset, @Nullable String sort, @Nullable String filter, @Nullable String fetchPlan, Map<String,Object> additionalParams) extends Record
Parameters of loading a list of entities.

  • Constructor Details

    • LoadListParams

      public LoadListParams(String entityName, int limit, int offset, @Nullable String sort, @Nullable String filter, @Nullable String fetchPlan, Map<String,Object> additionalParams)
      Creates an instance of a LoadListParams record class.
      Parameters:
      entityName - the value for the entityName record component
      limit - the value for the limit record component
      offset - the value for the offset record component
      sort - the value for the sort record component
      filter - the value for the filter record component
      fetchPlan - the value for the fetchPlan record component
      additionalParams - the value for the additionalParams record component

    • LoadListParams

      public LoadListParams(String entityName, int limit, int offset, @Nullable String sort, @Nullable String filter, @Nullable String fetchPlan)

    • LoadListParams

      public LoadListParams(String entityName, @Nullable String filter)

  • 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.

    • entityName

      public String entityName()
      Returns the value of the entityName record component.
      Returns:
      the value of the entityName record component

    • limit

      public int limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component

    • offset

      public int offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • sort

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

    • filter

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

    • fetchPlan

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

    • additionalParams

      public Map<String,Object> additionalParams()
      Returns the value of the additionalParams record component.
      Returns:
      the value of the additionalParams record component