io.sphere.sdk.apiclient.queries

Interface ApiClientQuery

All Superinterfaces:

ExpansionPathContainer<ApiClient>, MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>, MetaModelReferenceExpansionDsl<ApiClient,ApiClientQuery,ApiClientExpansionModel<ApiClient>>, Query<ApiClient>, QueryDsl<ApiClient,ApiClientQuery>, ReferenceExpansionDsl<ApiClient,ApiClientQuery>, ReferenceExpansionSupport<ApiClient>, ResourceQuery<ApiClient>, SphereRequest<PagedQueryResult<ApiClient>>

public interface ApiClientQuery
extends MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

{@doc.gen summary api-clients

Field Summary

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

MAX_OFFSET, MIN_OFFSET

Method Summary

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

plusPredicates

ApiClientQuery plusPredicates(Function<ApiClientQueryModel,QueryPredicate<ApiClient>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

plusPredicates in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

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

ApiClientQuery plusPredicates(QueryPredicate<ApiClient> 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<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

plusPredicates in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(QueryPredicate)

plusPredicates

ApiClientQuery plusPredicates(List<QueryPredicate<ApiClient>> 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<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

plusPredicates in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the existing predicate list plus the new predicate list

See Also:

QueryDsl.withPredicates(List)

plusSort

ApiClientQuery plusSort(Function<ApiClientQueryModel,QuerySort<ApiClient>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

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

ApiClientQuery plusSort(List<QuerySort<ApiClient>> sort)

Description copied from interface: QueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

plusSort in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.withSort(List)

plusSort

ApiClientQuery plusSort(QuerySort<ApiClient> sort)

Description copied from interface: QueryDsl

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

Specified by:

plusSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

plusSort in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.withSort(QuerySort)

withPredicates

ApiClientQuery withPredicates(Function<ApiClientQueryModel,QueryPredicate<ApiClient>> predicateFunction)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

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

ApiClientQuery withPredicates(QueryPredicate<ApiClient> queryPredicate)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

withPredicates in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

queryPredicate - the new predicate

Returns:

instance with the predicate

See Also:

QueryDsl.plusPredicates(QueryPredicate)

withPredicates

ApiClientQuery withPredicates(List<QueryPredicate<ApiClient>> queryPredicates)

Description copied from interface: QueryDsl

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

Specified by:

withPredicates in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

withPredicates in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

queryPredicates - the new predicate list

Returns:

instance with the predicate list

See Also:

QueryDsl.plusPredicates(List)

withSort

ApiClientQuery withSort(Function<ApiClientQueryModel,QuerySort<ApiClient>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Parameters:

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

Returns:

Query with sort

See Also:

MetaModelQueryDsl.plusSort(Function)

withSort

ApiClientQuery withSort(List<QuerySort<ApiClient>> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

withSort in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(List)

withSort

ApiClientQuery withSort(QuerySort<ApiClient> sort)

Description copied from interface: QueryDsl

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

Specified by:

withSort in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

Specified by:

withSort in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

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

Returns:

Query with sort

See Also:

QueryDsl.plusSort(QuerySort)

withSortMulti

ApiClientQuery withSortMulti(Function<ApiClientQueryModel,List<QuerySort<ApiClient>>> m)

Description copied from interface: MetaModelQueryDsl

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

Specified by:

withSortMulti in interface MetaModelQueryDsl<ApiClient,ApiClientQuery,ApiClientQueryModel,ApiClientExpansionModel<ApiClient>>

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

ApiClientQuery plusExpansionPaths(Function<ApiClientExpansionModel<ApiClient>,ExpansionPathContainer<ApiClient>> 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<ApiClient,ApiClientQuery,ApiClientExpansionModel<ApiClient>>

Parameters:

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

Returns:

new object

withExpansionPaths

ApiClientQuery withExpansionPaths(Function<ApiClientExpansionModel<ApiClient>,ExpansionPathContainer<ApiClient>> 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<ApiClient,ApiClientQuery,ApiClientExpansionModel<ApiClient>>

Parameters:

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

Returns:

new object

withFetchTotal

ApiClientQuery 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<ApiClient,ApiClientQuery>

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

ApiClientQuery 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<ApiClient,ApiClientQuery>

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

ApiClientQuery withOffset(Long offset)

Description copied from interface: QueryDsl

Returns a new query with the new offset as offset.

Specified by:

withOffset in interface QueryDsl<ApiClient,ApiClientQuery>

Parameters:

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

Returns:

a new query