io.sphere.sdk.customobjects.queries

Interface CustomObjectQuery<T>

Type Parameters:

T - The type of the value of this custom object.

All Superinterfaces:

ExpansionPathContainer<CustomObject<T>>, MetaModelQueryDsl<CustomObject<T>,CustomObjectQuery<T>,CustomObjectQueryModel<CustomObject<T>>,CustomObjectExpansionModel<CustomObject<T>>>, MetaModelReferenceExpansionDsl<CustomObject<T>,CustomObjectQuery<T>,CustomObjectExpansionModel<CustomObject<T>>>, Query<CustomObject<T>>, QueryDsl<CustomObject<T>,CustomObjectQuery<T>>, ReferenceExpansionDsl<CustomObject<T>,CustomObjectQuery<T>>, ReferenceExpansionSupport<CustomObject<T>>, ResourceQuery<CustomObject<T>>, SphereRequest<PagedQueryResult<CustomObject<T>>>

public interface CustomObjectQuery<T>
extends MetaModelQueryDsl<CustomObject<T>,CustomObjectQuery<T>,CustomObjectQueryModel<CustomObject<T>>,CustomObjectExpansionModel<CustomObject<T>>>

Queries custom objects.

withCustomObject(client(), "containerA", "key", customObjectA ->
    withCustomObject(client(), "containerB", "key", customObjectB -> {
        final Class<Foo> classForTheValue = Foo.class;
        final PagedQueryResult<CustomObject<Foo>> result =
                client().executeBlocking(CustomObjectQuery.of(classForTheValue).byContainer("containerA"));
        final List<CustomObject<Foo>> results = result.getResults();
        assertThat(results)
                .contains(customObjectA)
                .doesNotContain(customObjectB);
    })
);
See the test code.

See Also:

CustomObject

Field Summary

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

MAX_OFFSET, MIN_OFFSET

Method Summary

Modifier and Type	Method and Description
default CustomObjectQuery<T>	byContainer(String container)
static <T> CustomObjectQuery<T>	of(Class<T> valueClass) Query object for custom objects where the result value is a POJO.
static <T> CustomObjectQuery<T>	of(com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference) Query object for custom objects where the result value is a POJO.
static CustomObjectQuery<com.fasterxml.jackson.databind.JsonNode>	ofJsonNode()

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

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

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

withFetchTotal, withLimit, withLimit, withOffset, 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

Method Detail

of

static <T> CustomObjectQuery<T> of(com.fasterxml.jackson.core.type.TypeReference<T> valueTypeReference)

Query object for custom objects where the result value is a POJO.

Type Parameters:

T - the Java type of the value of the custom object

Parameters:

valueTypeReference - the type reference of the value of the custom object

Returns:

query object

of

static <T> CustomObjectQuery<T> of(Class<T> valueClass)

Query object for custom objects where the result value is a POJO.

Type Parameters:

T - the Java type of the value of the custom object

Parameters:

valueClass - the class of the value, if it not uses generics like lists, typically for POJOs

Returns:

query object

ofJsonNode

static CustomObjectQuery<com.fasterxml.jackson.databind.JsonNode> ofJsonNode()

byContainer

default CustomObjectQuery<T> byContainer(String container)