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

IListQuery

interface IListQuery : Queryable<IListQuery>

Interface for list queries that retrieve multiple items with a limit.

This interface extends Queryable and adds a limit parameter to control the maximum number of items returned by the query.

Inheritors

Properties

Link copied to clipboard
abstract val condition: Condition

The condition currently applied to this query.

Link copied to clipboard
abstract val limit: Int

The maximum number of items to return in the query result. This limits the size of the result set.

Link copied to clipboard
abstract val projection: Projection

The projection settings that control which fields are included in or excluded from the query results.

Link copied to clipboard
abstract val sort: List<Sort>

The list of sort criteria to apply to the query results. Each sort criterion specifies a field and direction (ascending/descending). Sorts are applied in the order they appear in the list.

Functions

Link copied to clipboard
open override fun appendCondition(append: Condition): IListQuery

Appends a condition to the existing condition using logical AND. This method combines the current condition with the appended condition.

Link copied to clipboard
open fun appendTenantId(tenantId: String): IListQuery

Appends a tenant ID condition to filter results by tenant.

Link copied to clipboard
abstract fun withCondition(newCondition: Condition): IListQuery

Creates a new query with the specified condition.

Link copied to clipboard
abstract fun withProjection(newProjection: Projection): IListQuery

Creates a new query with the specified projection.

Generated by Dokka
© 2025 Copyright