com.konakart.appif

Interface ReviewsIf

All Known Implementing Classes:

Reviews

public interface ReviewsIf

This is normally the object returned for API calls returning an array of Reviews. It contains an array of reviews and the total number of reviews matching the request, so that they can be paged. I also may contain the average rating for all reviews and an array of rating facets showing the number of reviews present for each rating.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAverageRating() The average rating for all reviews matching the search criteria.
NameNumberIf[]	getRatingFacets() An array of facets that show how many reviews exist for each rating.
ReviewIf[]	getReviewArray()
int	getTotalNumReviews()
void	setAverageRating(java.math.BigDecimal averageRating) The average rating for all reviews matching the search criteria.
void	setRatingFacets(NameNumberIf[] ratingFacets) An array of facets that show how many reviews exist for each rating.
void	setReviewArray(ReviewIf[] reviewArray)
void	setTotalNumReviews(int totalNumReviews)

Method Detail

getReviewArray

ReviewIf[] getReviewArray()

Returns:

Returns the reviewArray.

setReviewArray

void setReviewArray(ReviewIf[] reviewArray)

Parameters:

reviewArray - The reviewArray to set.

getTotalNumReviews

int getTotalNumReviews()

Returns:

Returns the totalNumReviews.

setTotalNumReviews

void setTotalNumReviews(int totalNumReviews)

Parameters:

totalNumReviews - The totalNumReviews to set.

getAverageRating

java.math.BigDecimal getAverageRating()

The average rating for all reviews matching the search criteria.

Returns:

the averageRating

setAverageRating

void setAverageRating(java.math.BigDecimal averageRating)

The average rating for all reviews matching the search criteria.

Parameters:

averageRating - the averageRating to set

getRatingFacets

NameNumberIf[] getRatingFacets()

An array of facets that show how many reviews exist for each rating.

Returns:

the ratingFacets

setRatingFacets

void setRatingFacets(NameNumberIf[] ratingFacets)

An array of facets that show how many reviews exist for each rating.

Parameters:

ratingFacets - the ratingFacets to set