org.rometools.feed.module.base
Interface Review

All Superinterfaces:
GlobalInterface, Serializable
All Known Subinterfaces:
GoogleBase
All Known Implementing Classes:
GoogleBaseImpl

public interface Review
extends GlobalInterface

This is an interface for the GoogleBase plug in that exposes methods used for critical reviews of other things.

Version:
$Revision: 1.1 $
Author:
Robert "kebernet" Cooper

Method Summary
 String[] getAuthors()
          Author of the item.
 String getDeliveryNotes()
          Additional instructions to explain the item’s delivery process.
 FloatUnit getDeliveryRadius()
          The maximum distance you will deliver an item in any direction.
 String getNameOfItemBeingReviewed()
          The name of an item being reviewed.
 Date getPublishDate()
          Date the item was published.
 Float getRating()
          Rating of the product or service on a scale of 1-5, with 5 as the best.
 String getReviewerType()
          The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
 String getReviewType()
          The category of the item being reviewed.
 URL getUrlOfItemBeingReviewed()
          The web page of an item being reviewed.
 void setAuthors(String[] authors)
          Author of the item.
 void setDeliveryNotes(String deliveryNotes)
          Additional instructions to explain the item’s delivery process.
 void setDeliveryRadius(FloatUnit deliveryRadius)
          The maximum distance you will deliver an item in any direction.
 void setNameOfItemBeingReviewed(String nameOfItemBeingReviewed)
          The name of an item being reviewed.
 void setPublishDate(Date publishDate)
          Date the item was published.
 void setRating(Float rating)
          Rating of the product or service on a scale of 1-5, with 5 as the best.
 void setReviewerType(String reviewerType)
          The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
 void setReviewType(String reviewType)
          The category of the item being reviewed.
 void setUrlOfItemBeingReviewed(URL urlOfItemBeingReviewed)
          The web page of an item being reviewed.
 
Methods inherited from interface org.rometools.feed.module.base.GlobalInterface
getExpirationDate, getExpirationDateTime, getId, getImageLinks, getLabels, setExpirationDate, setExpirationDateTime, setId, setImageLinks, setLabels
 

Method Detail

setAuthors

void setAuthors(String[] authors)
Author of the item.
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string

Parameters:
authors - Author of the item.

getAuthors

String[] getAuthors()
Author of the item.
author
Details Author of the item.
Example <g:author>John Steinbeck</g:author>
Attribute of Reference Items, News and Articles
Content type string

Returns:
Author of the item.

setDeliveryNotes

void setDeliveryNotes(String deliveryNotes)
Additional instructions to explain the item’s delivery process.
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
Content type string

Parameters:
deliveryNotes - Additional instructions to explain the item’s delivery process.

getDeliveryNotes

String getDeliveryNotes()
Additional instructions to explain the item’s delivery process.
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
Content type string

Returns:
Additional instructions to explain the item’s delivery process.

setDeliveryRadius

void setDeliveryRadius(FloatUnit deliveryRadius)
The maximum distance you will deliver an item in any direction.
delivery_radius
Details The maximum distance you will deliver an item in any direction.
Example <g:delivery_radius>10<g:/delivery_radius>
<g:delivery_radius>10km</g:delivery_radius>
Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
Content type floatUnit

Parameters:
deliveryRadius - The maximum distance you will deliver an item in any direction.

getDeliveryRadius

FloatUnit getDeliveryRadius()
The maximum distance you will deliver an item in any direction.
delivery_radius
Details The maximum distance you will deliver an item in any direction.
Example <g:delivery_radius>10<g:/delivery_radius>
<g:delivery_radius>10km</g:delivery_radius>
Attribute of Events, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
Content type floatUnit

Returns:
The maximum distance you will deliver an item in any direction.

setNameOfItemBeingReviewed

void setNameOfItemBeingReviewed(String nameOfItemBeingReviewed)
The name of an item being reviewed.
name_of_item_being_reviewed
Details The name of an item being reviewed.
Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
Attribute of Reviews
Content type string

Parameters:
nameOfItemBeingReviewed - The name of an item being reviewed.

getNameOfItemBeingReviewed

String getNameOfItemBeingReviewed()
The name of an item being reviewed.
name_of_item_being_reviewed
Details The name of an item being reviewed.
Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
Attribute of Reviews
Content type string

Returns:
The name of an item being reviewed.

setPublishDate

void setPublishDate(Date publishDate)
Date the item was published.
publish_date
Details Date the item was published in ISO 8601 format: YYYY-MM-DD
Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
Content type date

Parameters:
publishDate - Date the item was published.

getPublishDate

Date getPublishDate()
Date the item was published.
publish_date
Details Date the item was published in ISO 8601 format: YYYY-MM-DD
Example <g:publish_date>2005-12-20</g:publish_date>
Attribute of Reference Items
Content type date

Returns:
Date the item was published.

setRating

void setRating(Float rating)
Rating of the product or service on a scale of 1-5, with 5 as the best.
rating
Details Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only.
Example Acceptable:
<g:rating>4</g:rating>
Not acceptable:
<g:rating>good</g:rating>
Attribute of Reviews
Content type string

Parameters:
rating - Rating of the product or service on a scale of 1-5, with 5 as the best.

getRating

Float getRating()
Rating of the product or service on a scale of 1-5, with 5 as the best.
rating
Details Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only.
Example Acceptable:
<g:rating>4</g:rating>
Not acceptable:
<g:rating>good</g:rating>
Attribute of Reviews
Content type string

Returns:
Rating of the product or service on a scale of 1-5, with 5 as the best.

setReviewType

void setReviewType(String reviewType)
The category of the item being reviewed.
review_type
Details The category of the item being reviewed.
Example <g:review_type>toy</g:review_type>
<g:review_type>music</g:review_type>
<g:review_type>restaraunt</g:review_type>
Attribute of Reviews
Content type string

Parameters:
reviewType - The category of the item being reviewed.

getReviewType

String getReviewType()
The category of the item being reviewed.
review_type
Details The category of the item being reviewed.
Example <g:review_type>toy</g:review_type>
<g:review_type>music</g:review_type>
<g:review_type>restaraunt</g:review_type>
Attribute of Reviews
Content type string

Returns:
The category of the item being reviewed.

setReviewerType

void setReviewerType(String reviewerType)
The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
reviewer_type
Details The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site)
Example <g:reviewer_type>editorial</g:reviewer_type>
Attribute of Reviews
Content type string

Parameters:
reviewerType - The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).

getReviewerType

String getReviewerType()
The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
reviewer_type
Details The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site)
Example <g:reviewer_type>editorial</g:reviewer_type>
Attribute of Reviews
Content type string

Returns:
The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).

setUrlOfItemBeingReviewed

void setUrlOfItemBeingReviewed(URL urlOfItemBeingReviewed)
The web page of an item being reviewed.
url_of_item_being_reviewed
Details The web page of an item being reviewed.
Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
Attribute of Reviews
Content type uri

Parameters:
urlOfItemBeingReviewed - The web page of an item being reviewed.

getUrlOfItemBeingReviewed

URL getUrlOfItemBeingReviewed()
The web page of an item being reviewed.
url_of_item_being_reviewed
Details The web page of an item being reviewed.
Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
Attribute of Reviews
Content type uri

Returns:
The web page of an item being reviewed.


Copyright © 2013 ROME Project. All Rights Reserved.