io.sphere.sdk.products.queries

Interface ProductProjectionQuery

All Superinterfaces:

ExpansionPathContainer<ProductProjection>, LocaleSelectionRequestDsl<ProductProjectionQuery>, MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>, MetaModelReferenceExpansionDsl<ProductProjection,ProductProjectionQuery,ProductProjectionExpansionModel<ProductProjection>>, PriceSelectionRequestDsl<ProductProjectionQuery>, Query<ProductProjection>, QueryDsl<ProductProjection,ProductProjectionQuery>, ReferenceExpansionDsl<ProductProjection,ProductProjectionQuery>, ReferenceExpansionSupport<ProductProjection>, ResourceQuery<ProductProjection>, SphereRequest<PagedQueryResult<ProductProjection>>, StoreSelectionRequestDsl<ProductProjectionQuery>

public interface ProductProjectionQuery
extends MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>, PriceSelectionRequestDsl<ProductProjectionQuery>, LocaleSelectionRequestDsl<ProductProjectionQuery>, StoreSelectionRequestDsl<ProductProjectionQuery>

Provides a QueryDsl for product projections to formulate predicates, search expressions and reference expansion path expressions.

For further information how to use the query API to consult the Query API documentation.

Field Summary

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

MAX_OFFSET, MIN_OFFSET

Method Summary

Modifier and Type	Method and Description
default ProductProjectionQuery	byProductType(Referenceable<ProductType> productType)
default ProductProjectionQuery	bySku(List<String> skus)
default ProductProjectionQuery	bySku(String sku)
default ProductProjectionQuery	bySlug(Locale locale, String slug)
static ProductProjectionQuery	of(ProductProjectionType productProjectionType)
static ProductProjectionQuery	ofCurrent()
static ProductProjectionQuery	ofStaged()
ProductProjectionQuery	plusLocaleSelection(LocaleSelection localeSelection)
ProductProjectionQuery	plusPredicates(Function<ProductProjectionQueryModel,QueryPredicate<ProductProjection>> m) Returns a new instance with the new predicate appended (AND semantics).
ProductProjectionQuery	plusPredicates(List<QueryPredicate<ProductProjection>> queryPredicates) Returns a new instance with the new predicate list appended to the existing predicates (AND semantic).
ProductProjectionQuery	plusPredicates(QueryPredicate<ProductProjection> queryPredicate) Returns a new instance with the new predicate appended to the existing predicates (AND semantic).
static com.fasterxml.jackson.core.type.TypeReference<PagedQueryResult<ProductProjection>>	resultTypeReference() Creates a container which contains the full Java type information to deserialize the query result (NOT this class) from JSON.
ProductProjectionQuery	withLimit(Long limit) Creates a new instance which a limited amount of results.
ProductProjectionQuery	withLocaleSelection(LocaleSelection localeSelection)
ProductProjectionQuery	withOffset(Long offset) Returns a new query with the new offset as offset.
ProductProjectionQuery	withPredicates(Function<ProductProjectionQueryModel,QueryPredicate<ProductProjection>> predicateFunction) Returns a new instance with the new predicate as only predicate.
ProductProjectionQuery	withPredicates(List<QueryPredicate<ProductProjection>> queryPredicates) Returns a new instance with the new predicate list as predicates.
ProductProjectionQuery	withPredicates(QueryPredicate<ProductProjection> queryPredicate) Returns a new instance with the new predicate as only predicate.
ProductProjectionQuery	withPriceSelection(PriceSelection priceSelection) Uses the cart price selection logic to retrieve the prices for product variants.
ProductProjectionQuery	withSort(Function<ProductProjectionQueryModel,QuerySort<ProductProjection>> m) Returns a query with the new sort as only sort parameter.
ProductProjectionQuery	withSort(List<QuerySort<ProductProjection>> sort) Returns a query with the new sort list as only sort parameters.
ProductProjectionQuery	withSort(QuerySort<ProductProjection> sort) Returns a query with the new sort as only sort parameter.
ProductProjectionQuery	withSortMulti(Function<ProductProjectionQueryModel,List<QuerySort<ProductProjection>>> m) Returns a query with the new sort list as only sort parameters.
ProductProjectionQuery	withStoreSelection(StoreSelection storeSelection)

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

plusPredicates, plusSort, plusSort, plusSort, plusSort, withPredicates, withQueryParam, withSort

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

withFetchTotal, withLimit, withOffset

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.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

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

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

Methods inherited from interface io.sphere.sdk.products.search.PriceSelectionRequestDsl

getPriceSelection

Methods inherited from interface io.sphere.sdk.selection.LocaleSelectionRequestDsl

getLocaleSelection

Methods inherited from interface io.sphere.sdk.selection.StoreSelectionRequestDsl

getStoreSelection

Method Detail

resultTypeReference

static com.fasterxml.jackson.core.type.TypeReference<PagedQueryResult<ProductProjection>> resultTypeReference()

Creates a container which contains the full Java type information to deserialize the query result (NOT this class) from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

byProductType

default ProductProjectionQuery byProductType(Referenceable<ProductType> productType)

bySlug

default ProductProjectionQuery bySlug(Locale locale,
                                      String slug)

bySku

default ProductProjectionQuery bySku(String sku)

bySku

default ProductProjectionQuery bySku(List<String> skus)

ofStaged

static ProductProjectionQuery ofStaged()

ofCurrent

static ProductProjectionQuery ofCurrent()

of

static ProductProjectionQuery of(ProductProjectionType productProjectionType)

withLimit

ProductProjectionQuery withLimit(Long limit)

Description copied from interface: QueryDsl

Creates a new instance which a limited amount of results.

Limit restrictions on the API.

Specified by:

withLimit in interface QueryDsl<ProductProjection,ProductProjectionQuery>

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

ProductProjectionQuery withOffset(Long offset)

Description copied from interface: QueryDsl

Returns a new query with the new offset as offset.

Specified by:

withOffset in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

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

Returns:

a new query

withPredicates

ProductProjectionQuery withPredicates(List<QueryPredicate<ProductProjection>> queryPredicates)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

withPredicates in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the predicate list

See Also:

QueryDsl.plusPredicates(List)

withPredicates

ProductProjectionQuery withPredicates(QueryPredicate<ProductProjection> queryPredicate)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

withPredicates in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the predicate

See Also:

QueryDsl.plusPredicates(QueryPredicate)

withPredicates

ProductProjectionQuery withPredicates(Function<ProductProjectionQueryModel,QueryPredicate<ProductProjection>> predicateFunction)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Parameters:

predicateFunction - function given a meta model description of the model return a QueryPredicate

Returns:

instance with the predicate

See Also:

MetaModelQueryDsl.plusPredicates(Function)

plusPredicates

ProductProjectionQuery plusPredicates(List<QueryPredicate<ProductProjection>> queryPredicates)

Description copied from interface: QueryDsl

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

Specified by:

plusPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

plusPredicates in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(List)

plusPredicates

ProductProjectionQuery plusPredicates(QueryPredicate<ProductProjection> queryPredicate)

Description copied from interface: QueryDsl

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

Specified by:

plusPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

plusPredicates in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(QueryPredicate)

plusPredicates

ProductProjectionQuery plusPredicates(Function<ProductProjectionQueryModel,QueryPredicate<ProductProjection>> m)

Description copied from interface: MetaModelQueryDsl

Returns a new instance with the new predicate appended (AND semantics).

Specified by:

plusPredicates in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Parameters:

m - function given a meta model description of the model return a QueryPredicate

Returns:

instance with the predicate appended

See Also:

MetaModelQueryDsl.withPredicates(Function)

withSort

ProductProjectionQuery withSort(Function<ProductProjectionQueryModel,QuerySort<ProductProjection>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Parameters:

m - function given a meta model description of the model returns a QuerySort

Returns:

Query with sort

See Also:

MetaModelQueryDsl.plusSort(Function)

withSort

ProductProjectionQuery withSort(List<QuerySort<ProductProjection>> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

withSort in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(List)

withSort

ProductProjectionQuery withSort(QuerySort<ProductProjection> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Specified by:

withSort in interface QueryDsl<ProductProjection,ProductProjectionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(QuerySort)

withSortMulti

ProductProjectionQuery withSortMulti(Function<ProductProjectionQueryModel,List<QuerySort<ProductProjection>>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSortMulti in interface MetaModelQueryDsl<ProductProjection,ProductProjectionQuery,ProductProjectionQueryModel,ProductProjectionExpansionModel<ProductProjection>>

Parameters:

m - function given a meta model description of the model returns a list of QuerySort

Returns:

Query with sort

See Also:

MetaModelQueryDsl.plusSort(List), MetaModelQueryDsl.withSort(Function)

withPriceSelection

ProductProjectionQuery withPriceSelection(@Nullable
                                          PriceSelection priceSelection)

Uses the cart price selection logic to retrieve the prices for product variants.

Example for selecting just a currency

final List<PriceDraft> prices = asList(PriceDraft.of(EURO_30), PriceDraft.of(USD_20));
withProductOfPrices(prices, product -> {
    final ProductProjectionQuery request = ProductProjectionQuery.ofStaged()
            .withPredicates(m -> m.id().is(product.getId()))//to limit the test scope
            .withPriceSelection(PriceSelection.of(EUR));//price selection config
    final PagedQueryResult<ProductProjection> result = client().executeBlocking(request);
    assertThat(result.getCount()).isEqualTo(1);
    final ProductVariant masterVariant = result.getResults().get(0).getMasterVariant();
    assertThat(masterVariant.getPrice()).isNotNull().has(price(PriceDraft.of(EURO_30)));
});
See the test code.

Specified by:

withPriceSelection in interface PriceSelectionRequestDsl<ProductProjectionQuery>

Parameters:

priceSelection - parameters for the price selection, using null deletes the values

Returns:

request with new parameters

See Also:

ProductVariant.getPrice()

withLocaleSelection

ProductProjectionQuery withLocaleSelection(@Nullable
                                           LocaleSelection localeSelection)

Specified by:

withLocaleSelection in interface LocaleSelectionRequestDsl<ProductProjectionQuery>

plusLocaleSelection

ProductProjectionQuery plusLocaleSelection(@Nullable
                                           LocaleSelection localeSelection)

withStoreSelection

ProductProjectionQuery withStoreSelection(@Nullable
                                          StoreSelection storeSelection)

Specified by:

withStoreSelection in interface StoreSelectionRequestDsl<ProductProjectionQuery>