io.sphere.sdk.customobjects.queries.CustomObjectQueryModel 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

package io.sphere.sdk.customobjects.queries;

import io.sphere.sdk.customobjects.CustomObject;
import io.sphere.sdk.queries.RootJsonQueryModel;
import io.sphere.sdk.queries.ResourceQueryModel;
import io.sphere.sdk.queries.StringQuerySortingModel;

/**
 * Meta model to explore for which fields can be queried in a CustomObject.
 *
 *
 * Example:
 * {@include.example io.sphere.sdk.customobjects.queries.CustomObjectQueryIntegrationTest#queryWithClass()}
 *
 * @param  The type of the value of the custom object.
 * @see CustomObject
 */
public interface CustomObjectQueryModel> extends ResourceQueryModel {
    StringQuerySortingModel container();

    StringQuerySortingModel key();

    static > CustomObjectQueryModel of() {
        return new CustomObjectQueryModelImpl<>(null, null);
    }

    /**
     * Query model for {@link CustomObject#getValue()}.
     *
     * Example for custom objects which contain nested objects as value:
     * {@include.example io.sphere.sdk.customobjects.queries.CustomObjectQueryIntegrationTest#demoQueryByNestedValue()}
     * Example for custom objects which contain just a scalar value like a String or a an Integer:
     * {@include.example io.sphere.sdk.customobjects.queries.CustomObjectQueryIntegrationTest#demoQueryByFlatValue()}
     *
     * @return query model
     */
    RootJsonQueryModel value();
}