Serialized Form

  • Package com.broadleafcommerce.ratings.domain

    • Class com.broadleafcommerce.ratings.domain.RatingCountAndPercentage

      class RatingCountAndPercentage extends Object implements Serializable
      serialVersionUID:
      2L

      • Serialized Fields

        • rating
          int rating
          The rating value that we are counting.
        • ratingCount
          int ratingCount
          The total count of the rating value.
        • ratingPercentage
          double ratingPercentage
          The occurrence of this rating value from the total amount of ratings, displayed as a percentage formatted with 2 decimal places.

    • Class com.broadleafcommerce.ratings.domain.RatingDetail

      class RatingDetail extends Object implements Serializable
      serialVersionUID:
      2L

      • Serialized Fields

        • approveOrRejectDate
          Instant approveOrRejectDate
          The date that this review was approved or rejected
        • approveOrRejectUser
          String approveOrRejectUser
          The admin who approved or rejected this rating.
        • attributes
          Map<String,String> attributes
          Map to capture any additional data
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
        • customerId
          String customerId
          The database ID of the user who authored this rating. Nullable
        • customerName
          String customerName
          The customer name
        • editedDate
          Instant editedDate
          If edited, the date this review was edited
        • editedReview
          String editedReview
          If edited, the text of the edited review
        • id
          String id
          The ID of this rating
        • initialReviewDate
          Instant initialReviewDate
          The initial rating date
        • originalReview
          String originalReview
          The original review. This is what is displayed on the review page
        • rating
          int rating
          The rating of this review
        • ratingSummary
          RatingSummary ratingSummary
          The rating summary. By default, only the summary ID is populated.
        • rejectReason
          String rejectReason
          The reason for review rejection. Optional.
        • reviewStatus
          String reviewStatus
          The status of this review, e.g. APPROVED, REJECTED. See RatingDetailStatus
        • reviewTitle
          String reviewTitle
          The title of this review
        • verifiedPurchase
          boolean verifiedPurchase
          Is this review from a verified purchase?

    • Class com.broadleafcommerce.ratings.domain.RatingRequest

      class RatingRequest extends Object implements Serializable
      serialVersionUID:
      2L

      • Serialized Fields

        • attributes
          Map<String,String> attributes
          Map to capture any additional data
        • customerId
          String customerId
          The database ID of the user who authored this rating. Nullable
          See Also:
          • RatingDetail.customerId
        • customerName
          String customerName
          The customer name
          See Also:
          • RatingDetail.customerName
        • parentTargetId
          String parentTargetId
          If a Variant is being rated, this is the id of the parent product to the variant. Null if this rating is for a product.
          See Also:
          • RatingSummary.parentTargetId
        • rating
          Integer rating
          The rating of this review.
          See Also:
          • RatingDetail.rating
        • ratingTargetId
          String ratingTargetId
          The id of the product or variant that is the subject of this rating.
          See Also:
          • RatingSummary.ratingTargetId
        • ratingTargetType
          String ratingTargetType
          The rating target type, such as PRODUCT or VARIANT.
          See Also:
        • review
          String review
          The text of the review.
          See Also:
          • RatingDetail.originalReview
          • RatingDetail.editedReview
        • reviewTitle
          String reviewTitle
          The title of this review
          See Also:
          • RatingDetail.reviewTitle

    • Class com.broadleafcommerce.ratings.domain.RatingSummary

      class RatingSummary extends Object implements Serializable
      serialVersionUID:
      2L

      • Serialized Fields

        • attributes
          Map<String,String> attributes
          Map to capture any additional data
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
        • id
          String id
          The ID of this rating summary
        • numberOfApprovedRatings
          int numberOfApprovedRatings
          The total number of approved ratings for this target. Used to calculate the average rating. Includes ratings with APPROVED or NOT_NEEDED status.
          See Also:
        • numberOfRatings
          int numberOfRatings
          The total number of ratings for this target. This includes both approved and pending ratings.
        • parentRatingSummary
          RatingSummary parentRatingSummary
          The parent rating summary. For example, if this is a variant, this points to the RatingSummary of the parent product. Nullable.
        • parentTargetId
          String parentTargetId
          The parent target ID. For example, if the target type is a Variant, this would be the product's ID. Optional.
        • ratingTargetId
          String ratingTargetId
          The id of the rating target. For example the product or variant ID.
        • ratingTargetType
          String ratingTargetType
          The rating target type, such as PRODUCT or VARIANT. See RatingTargetType
        • ratingTotal
          long ratingTotal
          The total numerical value of all approved ratings for this summary. This is the sum of all approved ratings and is used to calculate the average rating. Includes ratings with APPROVED or NOT_NEEDED status.
          See Also:

  • Package com.broadleafcommerce.ratings.provider.jpa.domain

  • Package com.broadleafcommerce.ratings.service.exception