com.konakart.appif

Interface ReviewSearchIf

All Known Implementing Classes:

ReviewSearch

public interface ReviewSearchIf

Contains information required to specify search constraints for Reviews.

Method Summary

Modifier and Type	Method and Description
int	getCustomerId() If value is a positive number it is used as a constraint to find all reviews written by this customer.
int	getProductId() If value is a positive number it is used as a constraint to find all reviews for this product.
int	getRating() The rating is normally an integer in the range 1 to 5.
int	getRatingRule() The rule for the rating constraint.
int	getReviewId() If value is a positive number it is used as a constraint to find the review with this id.
int	getVendorId() If value is a positive number it is used as a constraint to find all reviews for this vendor.
boolean	isReturnAverageRating() When set, we calculate the average rating for all reviews matching the search criteria.
boolean	isReturnRatingFacets() When set, we return an array of facets that show how many reviews exist for each rating.
void	setCustomerId(int customerId) If value is a positive number it is used as a constraint to find all reviews written by this customer.
void	setProductId(int productId) If value is a positive number it is used as a constraint to find all reviews for this product.
void	setRating(int rating) The rating is normally an integer in the range 1 to 5.
void	setRatingRule(int ratingRule) The rule for the rating constraint.
void	setReturnAverageRating(boolean returnAverageRating) When set, we calculate the average rating for all reviews matching the search criteria.
void	setReturnRatingFacets(boolean returnRatingFacets) When set, we return an array of facets that show how many reviews exist for each rating.
void	setReviewId(int reviewId) If value is a positive number it is used as a constraint to find the review with this id.
void	setVendorId(int vendorId) If value is a positive number it is used as a constraint to find all reviews for this vendor.

Method Detail

getRating

int getRating()

The rating is normally an integer in the range 1 to 5.

Returns:

the rating

setRating

void setRating(int rating)

The rating is normally an integer in the range 1 to 5.

Parameters:

rating - the rating to set

getRatingRule

int getRatingRule()

The rule for the rating constraint. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_GREATER_THAN
• KKConstants.SEARCH_GREATER_EQUAL
• KKConstants.SEARCH_LESS_THAN
• KKConstants.SEARCH_LESS_EQUAL

Returns:

the ratingRule

setRatingRule

void setRatingRule(int ratingRule)

The rule for the rating constraint. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_GREATER_THAN
• KKConstants.SEARCH_GREATER_EQUAL
• KKConstants.SEARCH_LESS_THAN
• KKConstants.SEARCH_LESS_EQUAL

Parameters:

ratingRule - the ratingRule to set

getCustomerId

int getCustomerId()

If value is a positive number it is used as a constraint to find all reviews written by this customer.

Returns:

the customerId

setCustomerId

void setCustomerId(int customerId)

If value is a positive number it is used as a constraint to find all reviews written by this customer.

Parameters:

customerId - the customerId to set

getProductId

int getProductId()

If value is a positive number it is used as a constraint to find all reviews for this product.

Returns:

the productId

setProductId

void setProductId(int productId)

If value is a positive number it is used as a constraint to find all reviews for this product.

Parameters:

productId - the productId to set

getReviewId

int getReviewId()

If value is a positive number it is used as a constraint to find the review with this id.

Returns:

the reviewId

setReviewId

void setReviewId(int reviewId)

If value is a positive number it is used as a constraint to find the review with this id.

Parameters:

reviewId - the reviewId to set

isReturnAverageRating

boolean isReturnAverageRating()

When set, we calculate the average rating for all reviews matching the search criteria.

Returns:

the returnAverageRating

setReturnAverageRating

void setReturnAverageRating(boolean returnAverageRating)

When set, we calculate the average rating for all reviews matching the search criteria.

Parameters:

returnAverageRating - the returnAverageRating to set

isReturnRatingFacets

boolean isReturnRatingFacets()

When set, we return an array of facets that show how many reviews exist for each rating.

Returns:

the returnRatingFacets

setReturnRatingFacets

void setReturnRatingFacets(boolean returnRatingFacets)

When set, we return an array of facets that show how many reviews exist for each rating.

Parameters:

returnRatingFacets - the returnRatingFacets to set

getVendorId

int getVendorId()

If value is a positive number it is used as a constraint to find all reviews for this vendor.

Returns:

the vendorId

setVendorId

void setVendorId(int vendorId)

If value is a positive number it is used as a constraint to find all reviews for this vendor.

Parameters:

vendorId - the vendorId to set