Record Class TabularRowsResponse<P>

java.lang.Object
java.lang.Record
lib.aide.tabular.TabularRowsResponse<P>
Type Parameters:
P - The type of provenance information.
Record Components:
provenance - Optional provenance information about the data query.
data - The list of maps representing the rows returned for the current page.
lastRow - The index of the last row plus one if there are more rows, or -1 if this is the last row.
uxReportableError - Optional user-experience reportable error message.

public record TabularRowsResponse<P>(@Nullable P provenance, List<Map<String,Object>> data, int lastRow, @Nullable String uxReportableError) extends Record
Record representing the server-side response for rows request from AG Grid. This record includes the rows of data requested and an indication of the total number of rows, along with optional provenance information and error reporting.
  • Constructor Details

    • TabularRowsResponse

      public TabularRowsResponse(@Nullable P provenance, List<Map<String,Object>> data, int lastRow, @Nullable String uxReportableError)
      Creates an instance of a TabularRowsResponse record class.
      Parameters:
      provenance - the value for the provenance record component
      data - the value for the data record component
      lastRow - the value for the lastRow record component
      uxReportableError - the value for the uxReportableError 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.
    • provenance

      @Nullable public P provenance()
      Returns the value of the provenance record component.
      Returns:
      the value of the provenance record component
    • data

      public List<Map<String,Object>> data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component
    • lastRow

      public int lastRow()
      Returns the value of the lastRow record component.
      Returns:
      the value of the lastRow record component
    • uxReportableError

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