query-api/me.ahoo.wow.api.query/PagedQuery

PagedQuery

class PagedQuery @InternalWowApi constructor(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val pagination: Pagination = Pagination.DEFAULT, val total: TotalMode = TotalMode.BOUNDED) : Queryable<PagedQuery>

Data class representing a paginated query with filtering, projection, sorting, and pagination.

It supports all standard query operations (Queryable) and retrieves one page of the results.

Constructors

@InternalWowApi

constructor(filter: FilterExpression, projection: Projection = Projection.ALL, sort: List<Sort> = emptyList(), pagination: Pagination = Pagination.DEFAULT, total: TotalMode = TotalMode.BOUNDED)

Types

object Companion

Properties

open override val filter: FilterExpression

The filter expression to apply to the query.

val pagination: Pagination

The pagination settings to control which page and how many items to return.

open override val projection: Projection

The field projection to control which fields are included in the results.

open override val sort: List<Sort>

The sorting criteria to order the results.

val total: TotalMode

How the total is counted; TotalMode.BOUNDED, the default, stops at the budget's count limit.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String

open override fun withFilter(newFilter: FilterExpression): PagedQuery

Creates a new PagedQuery with the specified filter.

open override fun withProjection(newProjection: Projection): PagedQuery

Creates a new PagedQuery with the specified projection.