All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.syndication.feed.module.base.Review Maven / Gradle / Ivy

/*
 * Review.java
 *
 * Created on November 16, 2005, 1:58 PM
 *
 * This library is provided under dual licenses.
 * You may choose the terms of the Lesser General Public License or the Apache
 * License at your discretion.
 *
 *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.sun.syndication.feed.module.base;

import com.sun.syndication.feed.module.base.types.FloatUnit;
import java.net.URL;

import java.util.Date;


/**
 * This is an interface for the GoogleBase plug in that exposes methods used for
 * critical reviews of other things.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.1 $
 */
public interface Review extends GlobalInterface {
    /**
     * 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
* @param authors Author of the item. */ public 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
* @return Author of the item. */ public String[] getAuthors(); /** * 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
* @param deliveryNotes Additional instructions to explain the item’s delivery process. */ public 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
* @return Additional instructions to explain the item’s delivery process. */ public String getDeliveryNotes(); /** * 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
* @param deliveryRadius The maximum distance you will deliver an item in any direction. */ public 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
* @return The maximum distance you will deliver an item in any direction. */ public FloatUnit getDeliveryRadius(); /** * 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
* @param nameOfItemBeingReviewed The name of an item being reviewed. */ public 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
* @return The name of an item being reviewed. */ public String getNameOfItemBeingReviewed(); /** * 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
* @param publishDate Date the item was published. */ public 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
* @return Date the item was published. */ public Date getPublishDate(); /** * 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
* @param rating Rating of the product or service on a scale of 1-5, with 5 as the best. */ public 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
* @return Rating of the product or service on a scale of 1-5, with 5 as the best. */ public Float getRating(); /** * 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
* @param reviewType The category of the item being reviewed. */ public 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
* @return The category of the item being reviewed. */ public String getReviewType(); /** * 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
* @param 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). */ public 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
* @return 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). */ public String getReviewerType(); /** * 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
* @param urlOfItemBeingReviewed The web page of an item being reviewed. */ public 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
* @return The web page of an item being reviewed. */ public URL getUrlOfItemBeingReviewed(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy