io.sphere.sdk.search.SearchExpression Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphere-common Show documentation

sphere-common

There is a newer version: 1.0.0-M26

package io.sphere.sdk.search;

import javax.annotation.Nullable;

/**
 * Search expressions to use in a search request.
 * @param  Type of the resource for the search
 */
public interface SearchExpression {

    /**
     * Returns a search expression.
     * @return String with unescaped sphere search expression
     */
    String expression();

    /**
     * Generates the path for the attribute to apply the search expression.
     * Example: variants.attributes.color
     * @return the path for the attribute
     */
    String attributePath();

    /**
     * Generates the value applied to the search expression.
     * Example: range(0 to *)
     * @return the value of the expression
     */
    @Nullable
    String value();

}