/
ItemReview SFO

ItemReview SFO

Owned by Perry Tew
Last updated: Jun 14, 2017

Properties

 

Field

Type

Comment/Sample

 

Methods

Method

Returns

Parameters

Parameter Types

Comments/Sample

getOverall()BigDecimal  overall rating
getOverallAsStarsstring  html version of overall rating with stars images
getOverallAsStars(string[])stringstring[] 

array needs to have 5 elements, each of which is a complete url to an image.

  1. empty star
  2. quarter star
  3. half star
  4. three quarter star
  5. full star

Examples:

http://secure.ultracart.com/checkout/images/star_fade_0_4.png
http://secure.ultracart.com/checkout/images/star_fade_1_4.png
http://secure.ultracart.com/checkout/images/star_fade_2_4.png
http://secure.ultracart.com/checkout/images/star_fade_3_4.png
http://secure.ultracart.com/checkout/images/star_fade_4_4.png
getRatingScore()BigDecimal   
isRecommendToFriend()boolean   
getTitle()string   
getDate()string  MM/dd/yyyy format
getDateMillis()long  review date in milliseconds
getDateAsObject()Date   
getRatings()ItemReviewRating[]   
getReview()string  text commentary portion of review
getReviewOid()integer  unique id of review
getReviewerNickname()string   
getReviewerLocation()string   
getReviewerQuestions()ItemReviewerQuestion[]   
getHelpfulYesUrl()string  url of the cgi used to vote yes.
getHelpfulNoUrl()string  url of the cgi used to vote no.
getHelpfulYesVotes()integer   
getHelpfulNoVotes()integer   
getSortOrderFeatured()integer  pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by 'featured' flag

getSortOrderDate()

integer  pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by order date
getSortOrderRating()integer  pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by rating
getSortOrderHelpfulness()integer  pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by helpfulness
getSortOrderLength()integer  pass this result (sortOrderId) of this to $formatHelper.sortReviews(reviews, sortOrderId) to sort reviews by review length
getHelpfulNetVotes()integer  net summary of yes minus no votes
isFeatured()boolean  true if this review is featured, else false
getReviewerRank()integer*  if the review has an active customer profile tied to it, this returns the review rank, else null. Be careful with this method as it returns an object (Integer) and not a primitive. So you must check for a null condition before blindly using.
isReviewerExpert()boolean  true if the reviewer is considered an expert by the merchant.
getEdit()string  if (and only if) the merchant is logged in, this returns an anchor <a> tag that will open a separate browser window allowing the merchant to edit the review directly.

See Also