ReviewMgr (KonaKart Client Engine API Documentation (Struts 2 Storefront))

java.lang.Object
- com.konakart.al.BaseMgr
- - com.konakart.al.ReviewMgr

```
public class ReviewMgr
extends BaseMgr
```
Contains methods to read and write product reviews.

Field Summary

Fields
Modifier and Type Field and Description

static int PRODUCT_REVIEW
Product review

static int VENDOR_REVIEW
Vendor review
- Fields inherited from class com.konakart.al.BaseMgr
  eng, kkAppEng

Fields
Modifier and Type	Field and Description
`static int`	`PRODUCT_REVIEW` Product review
`static int`	`VENDOR_REVIEW` Vendor review

Constructor Summary

Constructors
Modifier Constructor and Description

protected ReviewMgr(com.konakart.appif.KKEngIf eng, KKAppEng kkAppEng)
Constructor

Constructors
Modifier	Constructor and Description
`protected`	`ReviewMgr(com.konakart.appif.KKEngIf eng, KKAppEng kkAppEng)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fetchReviewDetails(int revId)` Sets selectedReview by finding it within the currentReviews array.
`com.konakart.appif.ReviewsIf`	`fetchReviews(com.konakart.appif.DataDescriptorIf dd, com.konakart.appif.ReviewSearchIf rs)` Retrieves the reviews that match the criteria in a ReviewSearch object and puts them in the `currentReviews` array.
`com.konakart.appif.ReviewsIf`	`fetchVendorReviews(com.konakart.appif.DataDescriptorIf dd, com.konakart.appif.ReviewSearchIf rs, java.lang.String _vendorStoreId)` Retrieves the reviews that match the criteria in a ReviewSearch object and puts them in the `currentReviews` array.
`void`	`filterCurrentReviews(int rating, long timestamp)` The current reviews are filtered by rating.
`void`	`filterCurrentVendorReviews(int rating, long timestamp)` The current reviews are filtered by rating.
`int`	`getCurrentOffset()` Returns the currentOffset in the review array.
`int`	`getCurrentPage()`
`com.konakart.appif.ReviewIf[]`	`getCurrentReviews()` Returns an array of currentReviews.
`com.konakart.appif.DataDescriptorIf`	`getDataDesc()`
`int`	`getMaxRows()` Maximum number of reviews to show in a list.
`java.lang.String`	`getNavBack()` Static string - navigate backwards.
`java.lang.String`	`getNavNext()` Static string - navigate forwards.
`java.lang.String`	`getNavStart()` Static string - navigate to the start.
`int`	`getNumberOfReviews()` Returns the number of reviews currently retrieved.
`int`	`getNumPages()`
`java.util.ArrayList<java.lang.Integer>`	`getPageList()`
`int`	`getPageSize()` Used to get the maximum number of reviews to display.
`int[]`	`getRatingPercentage()` An array of 5 ints where index 0 contains the percentage of products for reviews with a 1 star rating and index 4 contains the percentage of products for reviews with a 5 star rating.
`int[]`	`getRatingQuantity()` An array of 5 ints where index 0 contains the number of products for reviews with a 1 star rating and index 4 contains the number of products for reviews with a 5 star rating.
`com.konakart.appif.ReviewSearchIf`	`getRevSearch()`
`long`	`getRevTimestamp()` A timestamp for when the last review search was done.
`com.konakart.appif.ReviewIf`	`getSelectedReview()` Returns the selectedReview.
`int`	`getShowBack()` Show the back button if set to 1.
`int`	`getShowNext()` Show the next button if set to 1.
`int`	`getTotalNumberOfReviews()` Returns the totalNumberOfReviews.
`boolean`	`isExpiredResultSet()`
`boolean`	`isMgrReady()` Is the Manager Ready?
`boolean`	`isShowTab()`
`void`	`navigateCurrentReviews(java.lang.String navDir, long timestamp)` This method is called to navigate through a list of reviews when the list is longer than maxRows. `navDir` can take the following values which are retrieved using getter methods on the ReviewMgr instance: getNavNext() getNavBack() getNavStart()
`void`	`navigateCurrentVendorReviews(java.lang.String navDir, long timestamp)` This method is called to navigate through a list of reviews when the list is longer than maxRows. `navDir` can take the following values which are retrieved using getter methods on the ReviewMgr instance: getNavNext() getNavBack() getNavStart()
`void`	`orderCurrentReviews(java.lang.String orderBy, long timestamp)` This method is called to change the order of a list of reviews in the currentReviews array.
`void`	`orderCurrentVendorReviews(java.lang.String orderBy, long timestamp)` This method is called to change the order of a list of reviews in the currentReviews array.
`void`	`refreshConfigs()` Refresh the configuration variables.
`void`	`reset()` Puts the ReviewContainer object back into it's original state with no reviews selected.
`void`	`saveNavigationForTimestamp()` Called from the JSP to the save the current navigation
`void`	`setCurrentPage(int currentPage)`
`void`	`setDataDesc(com.konakart.appif.DataDescriptorIf dataDesc)`
`void`	`setNumPages(int numPages)`
`void`	`setPageList(java.util.ArrayList<java.lang.Integer> pageList)`
`void`	`setPageSize(int num)` Used to set a user defined maximum number of reviews displayed on a page.
`void`	`setRatingPercentage(int[] ratingPercentage)` An array of 5 ints where index 0 contains the percentage of products for reviews with a 1 star rating and index 4 contains the percentage of products for reviews with a 5 star rating.
`void`	`setRatingQuantity(int[] ratingQuantity)` An array of 5 ints where index 0 contains the number of products for reviews with a 1 star rating and index 4 contains the number of products for reviews with a 5 star rating.
`void`	`setRevSearch(com.konakart.appif.ReviewSearchIf revSearch)`
`void`	`setRevTimestamp(long revTimestamp)` A timestamp for when the last review search was done.
`void`	`setShowTab(boolean showTab)`
`java.lang.String`	`truncateDesc(java.lang.String desc, int wordLength, int stringLength)` Format the description in order to truncate it and to split up very long words which could ruin the page formatting.
`int`	`writeReview(java.lang.String _reviewText, int rating, int customerId, int productId, int vendorId)` Save a review in the database.

Methods inherited from class com.konakart.al.BaseMgr
getEng, getKkAppEng, getPages, setEng, setKkAppEng

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRODUCT_REVIEW
```
public static final int PRODUCT_REVIEW
```
    Product review
    
    See Also:
    
    Constant Field Values
  - VENDOR_REVIEW
```
public static final int VENDOR_REVIEW
```
    Vendor review
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReviewMgr
```
protected ReviewMgr(com.konakart.appif.KKEngIf eng,
                    KKAppEng kkAppEng)
             throws com.konakart.app.KKException
```
    Constructor
    
    Parameters:
    
    eng - the eng
    
    kkAppEng - the kkAppEng
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
- Method Detail
  - refreshConfigs
```
public void refreshConfigs()
                    throws com.konakart.app.KKException
```
    Refresh the configuration variables. This is called automatically at a regular interval.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - reset
```
public void reset()
           throws com.konakart.app.KKException
```
    Puts the ReviewContainer object back into it's original state with no reviews selected.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - isMgrReady
```
public boolean isMgrReady()
```
    Is the Manager Ready?
    
    Overrides:
    
    isMgrReady in class BaseMgr
    
    Returns:
    
    true if this manager is ready for work, otherwise returns false.
  - fetchReviews
```
public com.konakart.appif.ReviewsIf fetchReviews(com.konakart.appif.DataDescriptorIf dd,
                                                 com.konakart.appif.ReviewSearchIf rs)
                                          throws com.konakart.app.KKException,
                                                 KKAppException
```
    Retrieves the reviews that match the criteria in a ReviewSearch object and puts them in the currentReviews array.
    
    Parameters:
    
    dd - Used to control the data offset, limit the number of items returned and set the sort order
    
    rs - Contains information used to search for reviews
    
    Returns:
    
    Returns a Reviews object
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - fetchVendorReviews
```
public com.konakart.appif.ReviewsIf fetchVendorReviews(com.konakart.appif.DataDescriptorIf dd,
                                                       com.konakart.appif.ReviewSearchIf rs,
                                                       java.lang.String _vendorStoreId)
                                                throws com.konakart.app.KKException,
                                                       KKAppException
```
    Retrieves the reviews that match the criteria in a ReviewSearch object and puts them in the currentReviews array.
    
    Parameters:
    
    dd - Used to control the data offset, limit the number of items returned and set the sort order
    
    rs - Contains information used to search for reviews
    
    _vendorStoreId - the _vendorStoreId
    
    Returns:
    
    Returns a Reviews object
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - navigateCurrentReviews
```
public void navigateCurrentReviews(java.lang.String navDir,
                                   long timestamp)
                            throws com.konakart.app.KKException,
                                   KKAppException
```
    This method is called to navigate through a list of reviews when the list is longer than maxRows.
    navDir can take the following values which are retrieved using getter methods on the ReviewMgr instance:
    - getNavNext()
    - getNavBack()
    - getNavStart()
    Parameters:
    
    navDir - The navigation direction
    
    timestamp - Indicates when the result set was created.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - navigateCurrentVendorReviews
```
public void navigateCurrentVendorReviews(java.lang.String navDir,
                                         long timestamp)
                                  throws com.konakart.app.KKException,
                                         KKAppException
```
    This method is called to navigate through a list of reviews when the list is longer than maxRows.
    navDir can take the following values which are retrieved using getter methods on the ReviewMgr instance:
    - getNavNext()
    - getNavBack()
    - getNavStart()
    Parameters:
    
    navDir - The navigation direction
    
    timestamp - Indicates when the result set was created.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - orderCurrentReviews
```
public void orderCurrentReviews(java.lang.String orderBy,
                                long timestamp)
                         throws com.konakart.app.KKException,
                                KKAppException
```
    This method is called to change the order of a list of reviews in the currentReviews array. The orderBy parameter can take a range of values. The valid orderBy values are:
    - DataDescConstants.ORDER_BY_DATE_ADDED
    - DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
    - DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
    - DataDescConstants.ORDER_BY_TIMES_READ
    - DataDescConstants.ORDER_BY_TIMES_READ_DESCENDING
    - DataDescConstants.ORDER_BY_TIMES_READ_ASCENDING
    - DataDescConstants.ORDER_BY_RATING
    - DataDescConstants.ORDER_BY_RATING_DESCENDING
    - DataDescConstants.ORDER_BY_RATING_ASCENDING
    *
    Parameters:
    
    orderBy - The order by parameter
    
    timestamp - Indicates when the result set was created.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - orderCurrentVendorReviews
```
public void orderCurrentVendorReviews(java.lang.String orderBy,
                                      long timestamp)
                               throws com.konakart.app.KKException,
                                      KKAppException
```
    This method is called to change the order of a list of reviews in the currentReviews array. The orderBy parameter can take a range of values. The valid orderBy values are:
    - DataDescConstants.ORDER_BY_DATE_ADDED
    - DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
    - DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
    - DataDescConstants.ORDER_BY_TIMES_READ
    - DataDescConstants.ORDER_BY_TIMES_READ_DESCENDING
    - DataDescConstants.ORDER_BY_TIMES_READ_ASCENDING
    - DataDescConstants.ORDER_BY_RATING
    - DataDescConstants.ORDER_BY_RATING_DESCENDING
    - DataDescConstants.ORDER_BY_RATING_ASCENDING
    *
    Parameters:
    
    orderBy - The order by parameter
    
    timestamp - Indicates when the result set was created.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - filterCurrentReviews
```
public void filterCurrentReviews(int rating,
                                 long timestamp)
                          throws com.konakart.app.KKException,
                                 KKAppException
```
    The current reviews are filtered by rating. If the rating filter is already set, then it is reset.
    
    Parameters:
    
    rating - the rating
    
    timestamp - the timestamp
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - filterCurrentVendorReviews
```
public void filterCurrentVendorReviews(int rating,
                                       long timestamp)
                                throws com.konakart.app.KKException,
                                       KKAppException
```
    The current reviews are filtered by rating. If the rating filter is already set, then it is reset.
    
    Parameters:
    
    rating - the rating
    
    timestamp - the timestamp
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - fetchReviewDetails
```
public void fetchReviewDetails(int revId)
                        throws com.konakart.app.KKException,
                               KKAppException
```
    Sets selectedReview by finding it within the currentReviews array. It throws an exception if the review cannot be found.
    
    Parameters:
    
    revId - The id of the selected review
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    KKAppException - an unexpected KKAppException exception
  - truncateDesc
```
public java.lang.String truncateDesc(java.lang.String desc,
                                     int wordLength,
                                     int stringLength)
```
    Format the description in order to truncate it and to split up very long words which could ruin the page formatting. If stringLength is set to zero, then it only truncates long words and doesn't truncate the string. If the description supplied is null, null is returned.
    
    Parameters:
    
    desc - The description to be formatted
    
    wordLength - The maximum word length
    
    stringLength - The maximum string length
    
    Returns:
    
    Return a truncated description
  - getNumberOfReviews
```
public int getNumberOfReviews()
```
    Returns the number of reviews currently retrieved.
    
    Returns:
    
    Returns the number of reviews currently retrieved.
  - writeReview
```
public int writeReview(java.lang.String _reviewText,
                       int rating,
                       int customerId,
                       int productId,
                       int vendorId)
                throws com.konakart.app.KKException
```
    Save a review in the database.
    
    Parameters:
    
    _reviewText - the text to put into the review
    
    rating - the rating for the review
    
    customerId - id of the customer writing the review
    
    productId - id of the product
    
    vendorId - id of the vendor
    
    Returns:
    
    returns the id of the review that was created
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getCurrentOffset
```
public int getCurrentOffset()
```
    Returns the currentOffset in the review array.
    
    Returns:
    
    Returns the currentOffset.
  - getCurrentReviews
```
public com.konakart.appif.ReviewIf[] getCurrentReviews()
```
    Returns an array of currentReviews.
    
    Returns:
    
    Returns the currentReviews.
  - getMaxRows
```
public int getMaxRows()
```
    Maximum number of reviews to show in a list.
    
    Returns:
    
    Returns the maxRows.
  - getShowBack
```
public int getShowBack()
```
    Show the back button if set to 1. Don't show the back button if set to 0.
    
    Returns:
    
    Returns the showBack.
  - getShowNext
```
public int getShowNext()
```
    Show the next button if set to 1. Don't show the next button if set to 0.
    
    Returns:
    
    Returns the showNext.
  - getSelectedReview
```
public com.konakart.appif.ReviewIf getSelectedReview()
```
    Returns the selectedReview.
    
    Returns:
    
    Returns the selectedReview.
  - getNavBack
```
public java.lang.String getNavBack()
```
    Static string - navigate backwards. It is the string required to pass to the navigateCurrentReviews() as the navdir attribute when navigating backwards.
    
    Returns:
    
    Returns the navBack.
  - getNavNext
```
public java.lang.String getNavNext()
```
    Static string - navigate forwards. It is the string required to pass to the navigateCurrentReviews() as the navdir attribute when navigating forwards.
    
    Returns:
    
    Returns the navNext.
  - getNavStart
```
public java.lang.String getNavStart()
```
    Static string - navigate to the start. It is the string required to pass to the navigateCurrentReviews() as the navdir attribute when navigating to the start.
    
    Returns:
    
    Returns the navStart.
  - getTotalNumberOfReviews
```
public int getTotalNumberOfReviews()
```
    Returns the totalNumberOfReviews.
    
    Returns:
    
    Returns the totalNumberOfReviews.
  - getDataDesc
```
public com.konakart.appif.DataDescriptorIf getDataDesc()
```
    Returns:
    
    the dataDesc
  - setDataDesc
```
public void setDataDesc(com.konakart.appif.DataDescriptorIf dataDesc)
```
    Parameters:
    
    dataDesc - the dataDesc to set
  - setPageSize
```
public void setPageSize(int num)
```
    Used to set a user defined maximum number of reviews displayed on a page. When set to a number greater than zero, this value is used instead of the value in the configuration variable MAX_DISPLAY_NEW_REVIEWS.
    
    Parameters:
    
    num - the num
  - getPageSize
```
public int getPageSize()
```
    Used to get the maximum number of reviews to display. The value is customizable by the customer.
    
    Returns:
    
    Returns the maximum number of reviews to display
  - getNumPages
```
public int getNumPages()
```
    Returns:
    
    the numPages
  - setNumPages
```
public void setNumPages(int numPages)
```
    Parameters:
    
    numPages - the numPages to set
  - getCurrentPage
```
public int getCurrentPage()
```
    Returns:
    
    the currentPage
  - setCurrentPage
```
public void setCurrentPage(int currentPage)
```
    Parameters:
    
    currentPage - the currentPage to set
  - getPageList
```
public java.util.ArrayList<java.lang.Integer> getPageList()
```
    Returns:
    
    the pageList
  - setPageList
```
public void setPageList(java.util.ArrayList<java.lang.Integer> pageList)
```
    Parameters:
    
    pageList - the pageList to set
  - getRevSearch
```
public com.konakart.appif.ReviewSearchIf getRevSearch()
```
    Returns:
    
    the revSearch
  - setRevSearch
```
public void setRevSearch(com.konakart.appif.ReviewSearchIf revSearch)
```
    Parameters:
    
    revSearch - the revSearch to set
  - getRatingQuantity
```
public int[] getRatingQuantity()
```
    An array of 5 ints where index 0 contains the number of products for reviews with a 1 star rating and index 4 contains the number of products for reviews with a 5 star rating.
    
    Returns:
    
    the ratingQuantity
  - setRatingQuantity
```
public void setRatingQuantity(int[] ratingQuantity)
```
    An array of 5 ints where index 0 contains the number of products for reviews with a 1 star rating and index 4 contains the number of products for reviews with a 5 star rating.
    
    Parameters:
    
    ratingQuantity - the ratingQuantity to set
  - getRatingPercentage
```
public int[] getRatingPercentage()
```
    An array of 5 ints where index 0 contains the percentage of products for reviews with a 1 star rating and index 4 contains the percentage of products for reviews with a 5 star rating.
    
    Returns:
    
    the ratingPercentage
  - setRatingPercentage
```
public void setRatingPercentage(int[] ratingPercentage)
```
    An array of 5 ints where index 0 contains the percentage of products for reviews with a 1 star rating and index 4 contains the percentage of products for reviews with a 5 star rating.
    
    Parameters:
    
    ratingPercentage - the ratingPercentage to set
  - getRevTimestamp
```
public long getRevTimestamp()
```
    A timestamp for when the last review search was done. Used to detect whether a result set is old when paging.
    
    Returns:
    
    the revTimestamp
  - setRevTimestamp
```
public void setRevTimestamp(long revTimestamp)
```
    A timestamp for when the last review search was done. Used to detect whether a result set is old when paging.
    
    Parameters:
    
    revTimestamp - the revTimestamp to set
  - isExpiredResultSet
```
public boolean isExpiredResultSet()
```
    Returns:
    
    the expiredResultSet
  - isShowTab
```
public boolean isShowTab()
```
    Returns:
    
    the showTab
  - setShowTab
```
public void setShowTab(boolean showTab)
```
    Parameters:
    
    showTab - the showTab to set
  - saveNavigationForTimestamp
```
public void saveNavigationForTimestamp()
```
    Called from the JSP to the save the current navigation

Class ReviewMgr

Field Summary

Fields inherited from class com.konakart.al.BaseMgr

Constructor Summary

Method Summary

Methods inherited from class com.konakart.al.BaseMgr

Methods inherited from class java.lang.Object

Field Detail

PRODUCT_REVIEW

VENDOR_REVIEW

Constructor Detail

ReviewMgr

Method Detail

refreshConfigs

reset

isMgrReady

fetchReviews

fetchVendorReviews

navigateCurrentReviews

navigateCurrentVendorReviews

orderCurrentReviews

orderCurrentVendorReviews

filterCurrentReviews

filterCurrentVendorReviews

fetchReviewDetails

truncateDesc

getNumberOfReviews

writeReview

getCurrentOffset

getCurrentReviews

getMaxRows

getShowBack

getShowNext

getSelectedReview

getNavBack

getNavNext

getNavStart

getTotalNumberOfReviews

getDataDesc

setDataDesc

setPageSize

getPageSize

getNumPages

setNumPages

getCurrentPage

setCurrentPage

getPageList

setPageList

getRevSearch

setRevSearch

getRatingQuantity

setRatingQuantity

getRatingPercentage

setRatingPercentage

getRevTimestamp

setRevTimestamp

isExpiredResultSet

isShowTab

setShowTab

saveNavigationForTimestamp