com.commercetools.sunrise.recommendations.ProductRecommender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common_2.11 Show documentation

common

The newest version!

package com.commercetools.sunrise.recommendations;

import com.google.inject.ImplementedBy;
import io.sphere.sdk.categories.Category;
import io.sphere.sdk.products.ProductProjection;

import java.util.List;
import java.util.concurrent.CompletionStage;

/**
 * Provides recommendation of products.
 */
@ImplementedBy(DefaultProductRecommender.class)
public interface ProductRecommender {

    /**
     * Gets a distinct list of products recommendations for the given product, of length {@code numProducts} or less
     * if the requested number is greater than the number of available products.
     * @param product the product to get suggestions for
     * @param numProducts the number of products the returned list should contain
     * @return a {@code CompletionStage} of the list of products of size {@code numProducts} or less
     */
    CompletionStage> relatedToProduct(final ProductProjection product, final int numProducts);

    /**
     * Gets a list of products recommendations for the given categories, of length {@code numProducts} or less
     * if the requested number is greater than the number of available products.
     * @param categories the categories to get suggestions from
     * @param numProducts the number of products the returned list should contain
     * @return a {@code CompletionStage} of the list of products of size {@code numProducts} or less
     */
    CompletionStage> relatedToCategories(final List categories, final int numProducts);
}