Package com.broadleafcommerce.recommendationengine.service

Interface UserRecommendationService<P extends UserRecommendation>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultUserRecommendationService
public interface UserRecommendationService<P extends UserRecommendation> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

  • Method Summary

    Modifier and Type
    Method
    Description
    UserRecommendation
    hydrate(UserRecommendation userRecommendation, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Hydrates the Catalog Item relationship onto the UserRecommendationItem.
    Optional<P>
    readByCustomerId(String customerId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read User Recommendation by the Broadleaf Customer Context ID JpaCustomerReference.getContextId()
    Optional<P>
    readByCustomerUsername(String customerUsername, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read User Recommendation by the Broadleaf Customer Username JpaCustomerReference.getUsername()
    Optional<P>
    readByUserId(String userId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read User Recommendation by the Numerical Customer Reference ID which is used by the ALS Recommendation Training Model JpaCustomerReference.getNumericId()

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

    create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

    readAll, readAll, readAll, readAll

  • Method Details

    • readByUserId

      Optional<P> readByUserId(@NonNull String userId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read User Recommendation by the Numerical Customer Reference ID which is used by the ALS Recommendation Training Model JpaCustomerReference.getNumericId()
      Parameters:
      userId - - the numerical customer reference identifier
      contextInfo -
      Returns:

    • readByCustomerId

      Optional<P> readByCustomerId(@NonNull String customerId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read User Recommendation by the Broadleaf Customer Context ID JpaCustomerReference.getContextId()
      Parameters:
      customerId - - Broadleaf's customer identifier
      contextInfo -
      Returns:

    • readByCustomerUsername

      Optional<P> readByCustomerUsername(@NonNull String customerUsername, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read User Recommendation by the Broadleaf Customer Username JpaCustomerReference.getUsername()
      Parameters:
      customerUsername - - Broadleaf's customer username
      contextInfo -
      Returns:

    • hydrate

      UserRecommendation hydrate(UserRecommendation userRecommendation, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Hydrates the Catalog Item relationship onto the UserRecommendationItem. that are in the {@link {@link UserRecommendation#getItems()}
      Parameters:
      userRecommendation - The recommendation to hydrate
      contextInfo -
      Returns:
      The hydrated userRecommendation.