io.sphere.sdk.states.queries.StateQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation
There is a newer version: 2.16.0
/*
This class has been generated by class io.sphere.sdk.annotations.processors.HasQueryEndpointAnnotationProcessor
induced by the annotation io.sphere.sdk.annotations.HasQueryEndpoint.
in the source class io.sphere.sdk.states.State.
To render this class the handlebars template 'queries/resourceQueryInterface.hbs' has been used.
*/
package io.sphere.sdk.states.queries;

import com.fasterxml.jackson.core.type.TypeReference;
import io.sphere.sdk.states.State;
import io.sphere.sdk.states.expansion.StateExpansionModel;
import io.sphere.sdk.expansion.ExpansionPathContainer;
import io.sphere.sdk.queries.PagedQueryResult;
import io.sphere.sdk.queries.MetaModelQueryDsl;
import io.sphere.sdk.queries.QueryPredicate;
import io.sphere.sdk.queries.QuerySort;



import java.util.List;
import java.util.Locale;
import java.util.function.Function;
import java.util.Optional;

/**
 * {@doc.gen summary states
 */
public interface StateQuery extends MetaModelQueryDsl> {

    /**
     * Creates a container which contains the full Java type information to deserialize the query result (NOT this class) from JSON.
     *
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(byte[], TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(String, TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObjectFromResource(String, TypeReference)
     *
     * @return type reference
     */
    static TypeReference> resultTypeReference() {
        return new TypeReference>() {
            @Override
            public String toString() {
                return "TypeReference>";
            }
        };
    }

    static StateQuery of() {
        return new StateQueryImpl();
    }

    @Override
    StateQuery plusPredicates(final Function> m);

    @Override
    StateQuery plusPredicates(final QueryPredicate queryPredicate);

    @Override
    StateQuery plusPredicates(final List> queryPredicates);

    @Override
    StateQuery plusSort(final Function> m);

    @Override
    StateQuery plusSort(final List> sort);

    @Override
    StateQuery plusSort(final QuerySort sort);

    @Override
    StateQuery withPredicates(final Function> predicateFunction);

    @Override
    StateQuery withPredicates(final QueryPredicate queryPredicate);

    @Override
    StateQuery withPredicates(final List> queryPredicates);

    @Override
    StateQuery withSort(final Function> m);

    @Override
    StateQuery withSort(final List> sort);

    @Override
    StateQuery withSort(final QuerySort sort);

    @Override
    StateQuery withSortMulti(final Function>> m);

    @Override
    StateQuery plusExpansionPaths(final Function, ExpansionPathContainer> m);

    @Override
    StateQuery withExpansionPaths(final Function, ExpansionPathContainer> m);

    @Override
    StateQuery withFetchTotal(final boolean fetchTotal);

    @Override
    StateQuery withLimit(final Long limit);

    @Override
    StateQuery withOffset(final Long offset);

        default StateQuery byKey(final String key) {
        return withPredicates(StateQueryModel.of().key().is(key));
    }
}