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

Queryable

interface Queryable<Q : Queryable<Q>> : ConditionCapable<Q> , ProjectionCapable<Q> , SortCapable

Interface for query objects that support comprehensive querying capabilities.

This interface combines condition filtering, field projection, and sorting capabilities to provide a complete query interface for retrieving and filtering data.

Parameters

The type of the query object that implements this interface, enabling method chaining.

Inheritors

IListQuery

IPagedQuery

ISingleQuery

Properties

condition

abstract val condition: Condition

The condition currently applied to this query.

projection

abstract val projection: Projection

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

sort

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

appendCondition

open override fun appendCondition(append: Condition): Q

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

appendTenantId

open fun appendTenantId(tenantId: String): Q

Appends a tenant ID condition to filter results by tenant.

withCondition

abstract fun withCondition(newCondition: Condition): Q

Creates a new query with the specified condition.

withProjection

abstract fun withProjection(newProjection: Projection): Q

Creates a new query with the specified projection.