io.sphere.sdk.queries

Interface QueryDsl<T,C extends QueryDsl<T,C>>

Type Parameters:

T - type of the query result

C - type of the class implementing this class

All Superinterfaces:

ExpansionPathContainer<T>, Query<T>, ReferenceExpansionDsl<T,C>, ReferenceExpansionSupport<T>, ResourceQuery<T>, SphereRequest<PagedQueryResult<T>>

All Known Subinterfaces:

ApiClientQuery, CartDiscountQuery, CartInStoreQuery, CartQuery, CategoryQuery, ChannelQuery, CustomerGroupQuery, CustomerInStoreQuery, CustomerQuery, CustomObjectQuery<T>, DiscountCodeQuery, ExtensionQuery, InventoryEntryQuery, JsonNodeQuery, MessageQuery, MetaModelQueryDsl<T,C,Q,E>, OrderEditQuery, OrderInStoreQuery, OrderQuery, PaymentQuery, ProductDiscountQuery, ProductProjectionInStoreQuery, ProductProjectionQuery, ProductQuery, ProductSelectionQuery, ProductTypeQuery, ReviewQuery, ShippingMethodQuery, ShoppingListInStoreQuery, ShoppingListQuery, StateQuery, StoreQuery, SubscriptionQuery, TaxCategoryQuery, TypeQuery, ZoneQuery

All Known Implementing Classes:

MetaModelQueryDslImpl

public interface QueryDsl<T,C extends QueryDsl<T,C>>
extends ResourceQuery<T>, ReferenceExpansionDsl<T,C>

Query request interface for immutable value classes which can copy themselves with modified fields.

Field Summary

Fields inherited from interface io.sphere.sdk.queries.Query

MAX_OFFSET, MIN_OFFSET

Method Summary

Modifier and Type	Method and Description
C	plusPredicates(List<QueryPredicate<T>> predicates) Returns a new instance with the new predicate list appended to the existing predicates (AND semantic).
C	plusPredicates(QueryPredicate<T> predicate) Returns a new instance with the new predicate appended to the existing predicates (AND semantic).
C	plusPredicates(String predicate) Returns a new instance with the new predicate appended to the existing predicates (AND semantic).
C	plusSort(List<QuerySort<T>> sort) Returns a query with the sort expressions appended to the existing ones.
C	plusSort(QuerySort<T> sort) Returns a query with the sort expression appended to the existing ones.
C	plusSort(String sort) Returns a query with the sort expression appended to the existing ones.
C	withFetchTotal(boolean fetchTotal) Enables/disables a flag it the total amount of items should be counted.
default C	withLimit(long limit) Creates a new instance which a limited amount of results.
C	withLimit(Long limit) Creates a new instance which a limited amount of results.
default C	withOffset(long offset) Returns a new query with the new offset as offset.
C	withOffset(Long offset) Returns a new query with the new offset as offset.
C	withPredicates(List<QueryPredicate<T>> predicates) Returns a new instance with the new predicate list as predicates.
C	withPredicates(QueryPredicate<T> predicate) Returns a new instance with the new predicate as only predicate.
C	withPredicates(String predicate) Returns a new instance with the new predicate as only predicate.
C	withSort(List<QuerySort<T>> sort) Returns a query with the new sort list as only sort parameters.
C	withSort(QuerySort<T> sort) Returns a query with the new sort as only sort parameter.
C	withSort(String sort) Returns a query with the new sort as only sort parameter.

Methods inherited from interface io.sphere.sdk.queries.ResourceQuery

endpoint, expansionPaths, fetchTotal, limit, offset, predicates, sort

Methods inherited from interface io.sphere.sdk.queries.Query

deserialize, toQuery

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Method Detail

withPredicates

C withPredicates(List<QueryPredicate<T>> predicates)

Returns a new instance with the new predicate list as predicates.

Parameters:

predicates - the new predicate list

Returns:

instance with the predicate list

See Also:

plusPredicates(List)

withPredicates

C withPredicates(QueryPredicate<T> predicate)

Returns a new instance with the new predicate as only predicate.

Parameters:

predicate - the new predicate

Returns:

instance with the predicate

See Also:

plusPredicates(QueryPredicate)

withPredicates

C withPredicates(String predicate)

Returns a new instance with the new predicate as only predicate.

Parameters:

predicate - the new predicate

Returns:

instance with the predicate

See Also:

plusPredicates(QueryPredicate)

plusPredicates

C plusPredicates(List<QueryPredicate<T>> predicates)

Returns a new instance with the new predicate list appended to the existing predicates (AND semantic).

Parameters:

predicates - the new predicate list

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

withPredicates(List)

plusPredicates

C plusPredicates(QueryPredicate<T> predicate)

Returns a new instance with the new predicate appended to the existing predicates (AND semantic).

Parameters:

predicate - the new predicate

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

withPredicates(QueryPredicate)

plusPredicates

C plusPredicates(String predicate)

Returns a new instance with the new predicate appended to the existing predicates (AND semantic).

Parameters:

predicate - the new predicate

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

withPredicates(QueryPredicate)

withSort

C withSort(List<QuerySort<T>> sort)

Returns a query with the new sort list as only sort parameters.

Parameters:

sort - list of sorts how the results of the query should be sorted

Returns:

Query with sort

See Also:

plusSort(List)

withSort

C withSort(QuerySort<T> sort)

Returns a query with the new sort as only sort parameter.

Parameters:

sort - sort expression how the results of the query should be sorted

Returns:

Query with sort

See Also:

plusSort(QuerySort)

withSort

C withSort(String sort)

Returns a query with the new sort as only sort parameter.

Parameters:

sort - sort expression how the results of the query should be sorted

Returns:

Query with sort

See Also:

plusSort(QuerySort)

plusSort

C plusSort(List<QuerySort<T>> sort)

Returns a query with the sort expressions appended to the existing ones.

Parameters:

sort - sort expressions how the results of the query should be sorted

Returns:

Query with sort

See Also:

withSort(List)

plusSort

C plusSort(QuerySort<T> sort)

Returns a query with the sort expression appended to the existing ones.

Parameters:

sort - sort expression how the results of the query should be sorted

Returns:

Query with sort

See Also:

withSort(QuerySort)

plusSort

C plusSort(String sort)

Returns a query with the sort expression appended to the existing ones.

Parameters:

sort - sort expression how the results of the query should be sorted

Returns:

Query with sort

See Also:

withSort(QuerySort)

withFetchTotal

C withFetchTotal(boolean fetchTotal)

Enables/disables a flag it the total amount of items should be counted.

If fetchTotal is true then PagedQueryResult.getTotal() is null.

Parameters:

fetchTotal - enable the total count if true (default on the construction of the QueryDsl).

Returns:

the same QueryDsl as this instance but with the updated flag

withLimit

C withLimit(Long limit)

Creates a new instance which a limited amount of results.

Limit restrictions on the API.

Parameters:

limit - the maximum amount of items of T which should be included in the PagedQueryResult.

Returns:

copy of this item with modified limit settings

See Also:

PagedQueryResult.getResults()

withLimit

default C withLimit(long limit)

Creates a new instance which a limited amount of results.

Limit restrictions on the API.

Parameters:

limit - the maximum amount of items of T which should be included in the PagedQueryResult.

Returns:

copy of this item with modified limit settings

See Also:

PagedQueryResult.getResults()

withOffset

C withOffset(Long offset)

Returns a new query with the new offset as offset.

Parameters:

offset - the number of items which should be omitted in the query result.

Returns:

a new query

Throws:

IllegalArgumentException - if offset is not between 0L and 100000L.

withOffset

default C withOffset(long offset)

Returns a new query with the new offset as offset.

Parameters:

offset - the number of items which should be omitted in the query result.

Returns:

a new query

Throws:

IllegalArgumentException - if offset is not between 0L and 100000L.