Interface PaginationRenderingRequest

public interface PaginationRenderingRequest

Read-only semantic facts supplied by Hibernate when selecting how to render pagination for one query part.

Implementations of PaginationRenderingSupport should inspect these facts and return a PaginationRenderingPlan. They should not mutate the query part or retain this request after PaginationRenderingSupport.determinePlan(PaginationRenderingRequest).

Since:
8.0

  • Method Summary

    Modifier and Type
    Method
    Description
    FetchClauseType
    fetchClauseType()
    The semantic kind of fetch clause, including whether ties or percentages are requested.
    boolean
    hasFetch()
    Whether this query part has an effective fetch limit.
    boolean
    hasOffset()
    Whether this query part has an effective offset.
    boolean
    isNestedInQueryGroup()
    Whether this query part is nested in a query group and therefore may have stricter clause-placement rules.
    boolean
    isRowNumberingCurrentQueryPart()
    Whether row-numbering emulation is currently being rendered for this same query part.
    QueryPart
    queryPart()
    The query part whose pagination clause is being rendered.
    boolean
    usesQueryOptionsLimit()
    Whether pagination originates in execution-time query options instead of an explicit SQL AST fetch or offset clause.

  • Method Details

    • queryPart

      QueryPart queryPart()
      The query part whose pagination clause is being rendered.

    • usesQueryOptionsLimit

      boolean usesQueryOptionsLimit()
      Whether pagination originates in execution-time query options instead of an explicit SQL AST fetch or offset clause.

    • hasOffset

      boolean hasOffset()
      Whether this query part has an effective offset.

    • hasFetch

      boolean hasFetch()
      Whether this query part has an effective fetch limit.

    • fetchClauseType

      FetchClauseType fetchClauseType()
      The semantic kind of fetch clause, including whether ties or percentages are requested.

    • isRowNumberingCurrentQueryPart

      boolean isRowNumberingCurrentQueryPart()
      Whether row-numbering emulation is currently being rendered for this same query part.

    • isNestedInQueryGroup

      boolean isNestedInQueryGroup()
      Whether this query part is nested in a query group and therefore may have stricter clause-placement rules.