io.sphere.sdk.extensions.queries

Interface ExtensionQuery

All Superinterfaces:

ExpansionPathContainer<Extension>, MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>, MetaModelReferenceExpansionDsl<Extension,ExtensionQuery,ExtensionExpansionModel<Extension>>, Query<Extension>, QueryDsl<Extension,ExtensionQuery>, ReferenceExpansionDsl<Extension,ExtensionQuery>, ReferenceExpansionSupport<Extension>, ResourceQuery<Extension>, SphereRequest<PagedQueryResult<Extension>>

public interface ExtensionQuery
extends MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

{@doc.gen summary extensions

Field Summary

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

MAX_OFFSET, MIN_OFFSET

Method Summary

Modifier and Type	Method and Description
static ExtensionQuery	of()
ExtensionQuery	plusExpansionPaths(Function<ExtensionExpansionModel<Extension>,ExpansionPathContainer<Extension>> m) Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.
ExtensionQuery	plusPredicates(Function<ExtensionQueryModel,QueryPredicate<Extension>> m) Returns a new instance with the new predicate appended (AND semantics).
ExtensionQuery	plusPredicates(List<QueryPredicate<Extension>> queryPredicates) Returns a new instance with the new predicate list appended to the existing predicates (AND semantic).
ExtensionQuery	plusPredicates(QueryPredicate<Extension> queryPredicate) Returns a new instance with the new predicate appended to the existing predicates (AND semantic).
ExtensionQuery	plusSort(Function<ExtensionQueryModel,QuerySort<Extension>> m) Returns a query with the sort expression appended to the existing ones.
ExtensionQuery	plusSort(List<QuerySort<Extension>> sort) Returns a query with the sort expressions appended to the existing ones.
ExtensionQuery	plusSort(QuerySort<Extension> sort) Returns a query with the sort expression appended to the existing ones.
static com.fasterxml.jackson.core.type.TypeReference<PagedQueryResult<Extension>>	resultTypeReference() Creates a container which contains the full Java type information to deserialize the query result (NOT this class) from JSON.
ExtensionQuery	withExpansionPaths(Function<ExtensionExpansionModel<Extension>,ExpansionPathContainer<Extension>> m) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.
ExtensionQuery	withFetchTotal(boolean fetchTotal) Enables/disables a flag it the total amount of items should be counted.
ExtensionQuery	withLimit(Long limit) Creates a new instance which a limited amount of results.
ExtensionQuery	withOffset(Long offset) Returns a new query with the new offset as offset.
ExtensionQuery	withPredicates(Function<ExtensionQueryModel,QueryPredicate<Extension>> predicateFunction) Returns a new instance with the new predicate as only predicate.
ExtensionQuery	withPredicates(List<QueryPredicate<Extension>> queryPredicates) Returns a new instance with the new predicate list as predicates.
ExtensionQuery	withPredicates(QueryPredicate<Extension> queryPredicate) Returns a new instance with the new predicate as only predicate.
ExtensionQuery	withSort(Function<ExtensionQueryModel,QuerySort<Extension>> m) Returns a query with the new sort as only sort parameter.
ExtensionQuery	withSort(List<QuerySort<Extension>> sort) Returns a query with the new sort list as only sort parameters.
ExtensionQuery	withSort(QuerySort<Extension> sort) Returns a query with the new sort as only sort parameter.
ExtensionQuery	withSortMulti(Function<ExtensionQueryModel,List<QuerySort<Extension>>> m) Returns a query with the new sort list as only sort parameters.

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

plusPredicates, plusSort, withPredicates, withQueryParam, withSort

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

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

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

Method Detail

resultTypeReference

static com.fasterxml.jackson.core.type.TypeReference<PagedQueryResult<Extension>> 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)

of

static ExtensionQuery of()

plusPredicates

ExtensionQuery plusPredicates(Function<ExtensionQueryModel,QueryPredicate<Extension>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

plusPredicates in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

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)

plusPredicates

ExtensionQuery plusPredicates(QueryPredicate<Extension> 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<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

plusPredicates in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(QueryPredicate)

plusPredicates

ExtensionQuery plusPredicates(List<QueryPredicate<Extension>> 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<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

plusPredicates in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(List)

plusSort

ExtensionQuery plusSort(Function<ExtensionQueryModel,QuerySort<Extension>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Parameters:

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

Returns:

Query with sort

See Also:

MetaModelQueryDsl.withSort(Function)

plusSort

ExtensionQuery plusSort(List<QuerySort<Extension>> sort)

Description copied from interface: QueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

plusSort in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.withSort(List)

plusSort

ExtensionQuery plusSort(QuerySort<Extension> sort)

Description copied from interface: QueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

plusSort in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.withSort(QuerySort)

withPredicates

ExtensionQuery withPredicates(Function<ExtensionQueryModel,QueryPredicate<Extension>> predicateFunction)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Parameters:

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

Returns:

instance with the predicate

See Also:

MetaModelQueryDsl.plusPredicates(Function)

withPredicates

ExtensionQuery withPredicates(QueryPredicate<Extension> queryPredicate)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

withPredicates in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the predicate

See Also:

QueryDsl.plusPredicates(QueryPredicate)

withPredicates

ExtensionQuery withPredicates(List<QueryPredicate<Extension>> queryPredicates)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

withPredicates in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the predicate list

See Also:

QueryDsl.plusPredicates(List)

withSort

ExtensionQuery withSort(Function<ExtensionQueryModel,QuerySort<Extension>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Parameters:

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

Returns:

Query with sort

See Also:

MetaModelQueryDsl.plusSort(Function)

withSort

ExtensionQuery withSort(List<QuerySort<Extension>> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

withSort in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(List)

withSort

ExtensionQuery withSort(QuerySort<Extension> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

Specified by:

withSort in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(QuerySort)

withSortMulti

ExtensionQuery withSortMulti(Function<ExtensionQueryModel,List<QuerySort<Extension>>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSortMulti in interface MetaModelQueryDsl<Extension,ExtensionQuery,ExtensionQueryModel,ExtensionExpansionModel<Extension>>

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)

plusExpansionPaths

ExtensionQuery plusExpansionPaths(Function<ExtensionExpansionModel<Extension>,ExpansionPathContainer<Extension>> m)

Description copied from interface: MetaModelReferenceExpansionDsl

Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.

An example in the product projection context:

final ProductProjectionByIdGet fetch1 = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
        .plusExpansionPaths(m -> m.categories());
assertThat(fetch1.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 = fetch1.plusExpansionPaths(m -> m.productType());
assertThat(fetch2.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")))
        .isEqualTo(listOf(fetch1.expansionPaths(), ExpansionPath.of("productType")));

//this is equivalent to

final ExpansionPath<ProductProjection> categoryExpand = ProductProjectionExpansionModel.of().categories().expansionPaths().get(0);
final ExpansionPath<ProductProjection> productTypeExpand = ProductProjectionExpansionModel.of().productType().expansionPaths().get(0);
final ProductProjectionByIdGet fetchB = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(asList(categoryExpand, productTypeExpand));
assertThat(fetchB.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")));
See the test code.

Specified by:

plusExpansionPaths in interface MetaModelReferenceExpansionDsl<Extension,ExtensionQuery,ExtensionExpansionModel<Extension>>

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object

withExpansionPaths

ExtensionQuery withExpansionPaths(Function<ExtensionExpansionModel<Extension>,ExpansionPathContainer<Extension>> m)

Description copied from interface: MetaModelReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .plusExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(m -> m.productType());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged")
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

Specified by:

withExpansionPaths in interface MetaModelReferenceExpansionDsl<Extension,ExtensionQuery,ExtensionExpansionModel<Extension>>

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object

withFetchTotal

ExtensionQuery withFetchTotal(boolean fetchTotal)

Description copied from interface: QueryDsl

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

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

Specified by:

withFetchTotal in interface QueryDsl<Extension,ExtensionQuery>

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

ExtensionQuery 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<Extension,ExtensionQuery>

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

ExtensionQuery withOffset(Long offset)

Description copied from interface: QueryDsl

Returns a new query with the new offset as offset.

Specified by:

withOffset in interface QueryDsl<Extension,ExtensionQuery>

Parameters:

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

Returns:

a new query