Package com.broadleafcommerce.ratings.service

Interface RatingSummaryService<P extends RatingSummary>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultRatingSummaryService
public interface RatingSummaryService<P extends RatingSummary> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

  • Method Summary

    Modifier and Type
    Method
    Description
    List<P>
    readByParentTargetId(String parentTargetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read a rating summary by its parent target ID.
    Optional<P>
    readByRatingTargetId(String ratingTargetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read by the rating target ID (e.g.
    Optional<P>
    readByRatingTargetIdAndTargetType(String ratingTargetId, String targetType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read by the rating target ID (e.g.
    List<P>
    readByTargetIdIn(Collection<String> targetIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read a collection of rating summaries by target ID.

    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

    • readByRatingTargetId

      Optional<P> readByRatingTargetId(String ratingTargetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read by the rating target ID (e.g. the product or variant ID)
      Parameters:
      ratingTargetId - The rating target ID
      contextInfo - The context
      Returns:
      The rating summary, if it exists for the target ID

    • readByParentTargetId

      List<P> readByParentTargetId(String parentTargetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read a rating summary by its parent target ID.
      Parameters:
      parentTargetId - The parent target ID.
      contextInfo - The context
      Returns:
      The rating summary, if it exists for the target ID

    • readByRatingTargetIdAndTargetType

      Optional<P> readByRatingTargetIdAndTargetType(String ratingTargetId, String targetType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read by the rating target ID (e.g. the product or variant ID) and target type.
      Parameters:
      ratingTargetId - The rating target ID
      targetType - The target type
      contextInfo - The context
      Returns:
      The rating summary, if it exists for the target ID and target type

    • readByTargetIdIn

      List<P> readByTargetIdIn(Collection<String> targetIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read a collection of rating summaries by target ID.
      Parameters:
      targetIds - The target IDs
      contextInfo - The context
      Returns:
      A list of target IDs