com.konakart.app

Class ReviewSearch

java.lang.Object

com.konakart.app.ReviewSearch

All Implemented Interfaces:

ReviewSearchIf

public class ReviewSearch
extends java.lang.Object
implements ReviewSearchIf

Review Search Object

Constructor Summary

Constructors

Constructor and Description
ReviewSearch() Constructor

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.
java.lang.String	toString()
java.lang.String	toStringBrief()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReviewSearch

public ReviewSearch()

Constructor

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Review Search object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing selected attributes of the Option object.

getRating

public int getRating()

Description copied from interface: ReviewSearchIf

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

Specified by:

getRating in interface ReviewSearchIf

Returns:

the rating

setRating

public void setRating(int rating)

Description copied from interface: ReviewSearchIf

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

Specified by:

setRating in interface ReviewSearchIf

Parameters:

rating - the rating to set

getRatingRule

public int getRatingRule()

Description copied from interface: ReviewSearchIf

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

Specified by:

getRatingRule in interface ReviewSearchIf

Returns:

the ratingRule

setRatingRule

public void setRatingRule(int ratingRule)

Description copied from interface: ReviewSearchIf

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

Specified by:

setRatingRule in interface ReviewSearchIf

Parameters:

ratingRule - the ratingRule to set

getCustomerId

public int getCustomerId()

Description copied from interface: ReviewSearchIf

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

Specified by:

getCustomerId in interface ReviewSearchIf

Returns:

the customerId

setCustomerId

public void setCustomerId(int customerId)

Description copied from interface: ReviewSearchIf

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

Specified by:

setCustomerId in interface ReviewSearchIf

Parameters:

customerId - the customerId to set

getProductId

public int getProductId()

Description copied from interface: ReviewSearchIf

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

Specified by:

getProductId in interface ReviewSearchIf

Returns:

the productId

setProductId

public void setProductId(int productId)

Description copied from interface: ReviewSearchIf

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

Specified by:

setProductId in interface ReviewSearchIf

Parameters:

productId - the productId to set

getReviewId

public int getReviewId()

Description copied from interface: ReviewSearchIf

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

Specified by:

getReviewId in interface ReviewSearchIf

Returns:

the reviewId

setReviewId

public void setReviewId(int reviewId)

Description copied from interface: ReviewSearchIf

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

Specified by:

setReviewId in interface ReviewSearchIf

Parameters:

reviewId - the reviewId to set

isReturnAverageRating

public boolean isReturnAverageRating()

Description copied from interface: ReviewSearchIf

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

Specified by:

isReturnAverageRating in interface ReviewSearchIf

Returns:

the returnAverageRating

setReturnAverageRating

public void setReturnAverageRating(boolean returnAverageRating)

Description copied from interface: ReviewSearchIf

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

Specified by:

setReturnAverageRating in interface ReviewSearchIf

Parameters:

returnAverageRating - the returnAverageRating to set

isReturnRatingFacets

public boolean isReturnRatingFacets()

Description copied from interface: ReviewSearchIf

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

Specified by:

isReturnRatingFacets in interface ReviewSearchIf

Returns:

the returnRatingFacets

setReturnRatingFacets

public void setReturnRatingFacets(boolean returnRatingFacets)

Description copied from interface: ReviewSearchIf

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

Specified by:

setReturnRatingFacets in interface ReviewSearchIf

Parameters:

returnRatingFacets - the returnRatingFacets to set

getVendorId

public int getVendorId()

Description copied from interface: ReviewSearchIf

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

Specified by:

getVendorId in interface ReviewSearchIf

Returns:

the vendorId

setVendorId

public void setVendorId(int vendorId)

Description copied from interface: ReviewSearchIf

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

Specified by:

setVendorId in interface ReviewSearchIf

Parameters:

vendorId - the vendorId to set