Package com.broadleafcommerce.catalog.domain.product

Class ReviewsSummary

java.lang.Object

com.broadleafcommerce.catalog.domain.product.ReviewsSummary

All Implemented Interfaces:

Serializable

public class ReviewsSummary
extends Object
implements Serializable

A structure containing a summary of a product's or variant's reviews.

Author:

Nathan Moore (nathandmoore)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ReviewsSummary()
ReviewsSummary(int numberOfReviews, BigDecimal rating, String ratingUnits)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	getNumberOfReviews()	The number of reviews made.
BigDecimal	getRating()	The overall rating for the reviewed product.
String	getRatingUnits()	The unit of measure for the rating, e.g., stars, thumbs, etc.
int	hashCode()
void	setNumberOfReviews(int numberOfReviews)	The number of reviews made.
void	setRating(BigDecimal rating)	The overall rating for the reviewed product.
void	setRatingUnits(String ratingUnits)	The unit of measure for the rating, e.g., stars, thumbs, etc.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ReviewsSummary

public ReviewsSummary()

ReviewsSummary

public ReviewsSummary(int numberOfReviews,
 BigDecimal rating,
 String ratingUnits)

Method Details

getNumberOfReviews

public int getNumberOfReviews()

The number of reviews made.

Returns:

The number of reviews made.

getRating

public BigDecimal getRating()

The overall rating for the reviewed product.

Returns:

The overall rating for the reviewed product.

getRatingUnits

public String getRatingUnits()

The unit of measure for the rating, e.g., stars, thumbs, etc.

Returns:

The unit of measure for the rating, e.g., stars, thumbs, etc.

setNumberOfReviews

public void setNumberOfReviews(int numberOfReviews)

The number of reviews made.

Parameters:

numberOfReviews - The number of reviews made.

setRating

public void setRating(BigDecimal rating)

The overall rating for the reviewed product.

Parameters:

rating - The overall rating for the reviewed product.

setRatingUnits

public void setRatingUnits(String ratingUnits)

The unit of measure for the rating, e.g., stars, thumbs, etc.

Parameters:

ratingUnits - The unit of measure for the rating, e.g., stars, thumbs, etc.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object