GData JavaScript Client 1.6

Class google.gdata.Rating

Object
   |
   +--google.gdata.Rating

class google.gdata.Rating


Describes a rating.
Defined in gdata.js


Field Summary
 {String|undefined} average
          Average rating.
 {String|undefined} max
          Rating scale's maximum value.
 {String|undefined} min
          Rating scale's minimum value.
 {String|undefined} numRaters
          Number of ratings taken into account when computing the average value.
 {String|undefined} rel
          Programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating.
 {String|undefined} value
          Rating value.
<static>  <final> String REL_OVERALL
          Overall rating, higher values mean better ratings.
<static>  <final> String REL_PRICE
          Price rating, higher values mean better ratings.
<static>  <final> String REL_QUALITY
          Quality rating, higher values mean better ratings.
 
Constructor Summary
google.gdata.Rating(<Object> opt_params)
            Constructs a rating using an object parameter whose property names match the setter method to use for each property.
 
Method Summary
 Number|undefined getAverage()
           Returns the average rating.
 Number|undefined getMax()
           Returns the rating scale's maximum value.
 Number|undefined getMin()
           Returns the rating scale's minimum value.
 Number|undefined getNumRaters()
           Returns the number of ratings taken into account when computing the average value.
 String|undefined getRel()
           Returns the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating.
 Number|undefined getValue()
           Returns the rating value.
 void setAverage(<Number|undefined> average)
           Sets the average rating.
 void setMax(<Number|undefined> max)
           Sets the rating scale's maximum value.
 void setMin(<Number|undefined> min)
           Sets the rating scale's minimum value.
 void setNumRaters(<Number|undefined> numRaters)
           Sets the number of ratings taken into account when computing the average value.
 void setRel(<String|undefined> rel)
           Sets the programmatic value that describes the aspect that's being rated, if not specified, the rating is an overall rating.
 void setValue(<Number|undefined> value)
           Sets the rating value.

Field Detail

average

{String|undefined} average

max

{String|undefined} max

min

{String|undefined} min

numRaters

{String|undefined} numRaters

rel

{String|undefined} rel

value

{String|undefined} value

REL_OVERALL

<static> <final> String REL_OVERALL

REL_PRICE

<static> <final> String REL_PRICE

REL_QUALITY

<static> <final> String REL_QUALITY

Constructor Detail

google.gdata.Rating

google.gdata.Rating(<Object> opt_params)

Method Detail

getAverage

Number|undefined getAverage()

getMax

Number|undefined getMax()

getMin

Number|undefined getMin()

getNumRaters

Number|undefined getNumRaters()

getRel

String|undefined getRel()

getValue

Number|undefined getValue()

setAverage

void setAverage(<Number|undefined> average)

setMax

void setMax(<Number|undefined> max)

setMin

void setMin(<Number|undefined> min)

setNumRaters

void setNumRaters(<Number|undefined> numRaters)

setRel

void setRel(<String|undefined> rel)

setValue

void setValue(<Number|undefined> value)

GData JavaScript Client 1.6

Documentation generated by JSDoc on Tue Oct 14 17:57:25 2008