Package org.ehrbase.api.dto

Record Class AqlQueryRequest

java.lang.Object
java.lang.Record
org.ehrbase.api.dto.AqlQueryRequest
Record Components:
aqlQuery - the actual aql query
parameters - additional query parameters
fetch - query limit to apply
offset - query offset to apply
public record AqlQueryRequest(@Nonnull org.ehrbase.openehr.sdk.aql.dto.AqlQuery aqlQuery, @Nullable Map<String,Object> parameters, @Nullable Long fetch, @Nullable Long offset) extends Record
The requested AQL to be executed by AqlQueryService.query(AqlQueryRequest).

  • Constructor Details

    • AqlQueryRequest

      public AqlQueryRequest(@Nonnull org.ehrbase.openehr.sdk.aql.dto.AqlQuery aqlQuery, @Nullable Map<String,Object> parameters, @Nullable Long fetch, @Nullable Long offset)
      Creates an instance of a AqlQueryRequest record class.
      Parameters:
      aqlQuery - the value for the aqlQuery record component
      parameters - the value for the parameters record component
      fetch - the value for the fetch record component
      offset - the value for the offset record component

  • Method Details

    • prepare

      public static AqlQueryRequest prepare(@Nonnull String queryString, @Nullable Map<String,Object> parameters, @Nullable Long fetch, @Nullable Long offset)
      Create a new AqlQueryRequest by parsing the given AQL queryString.
      See Also:

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

    • aqlQuery

      @Nonnull public org.ehrbase.openehr.sdk.aql.dto.AqlQuery aqlQuery()
      Returns the value of the aqlQuery record component.
      Returns:
      the value of the aqlQuery record component

    • parameters

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

    • fetch

      @Nullable public Long fetch()
      Returns the value of the fetch record component.
      Returns:
      the value of the fetch record component

    • offset

      @Nullable public Long offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component