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

Go to download

/*
 * Article.java
 *
 * Created on November 16, 2005, 1:01 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 java.util.Date;


/**
 * This is an interface for the GoogleBase plug in that exposes methods used for
 * Article or News entry types.
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.2 $
 */
public interface Article extends GlobalInterface {
    /**
     * Array of Author Names. Limit 10.
     * 
     *
     * 
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *  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 Array of Author Names. Limit 10.
     */
    public void setAuthors(String[] authors);

    /**
     * Array of Author Names. Limit 10.
     * 
     *
     * 
     *  
     * 
     * 
     *  
     *
     *  
     * 
     * 
     *  
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *
     *  
     *  
     * 
     * 
     *  author

     *  Details 
     *  Author of the item.

     *  Example  <g:author>John Steinbeck</g:author>

     *  Attribute of 
     *  Reference Items, News and Articles

     *  Content type 
     *  string
     * @return Array of author names.
     */
    public String[] getAuthors();

    /**
     * Source for this article.
     *
     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     *
     * 
     *
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  news_source

     *  Details 
     *  The source of news content.

     *  Example  <g:news_source>Journal</g:news_source>

     *  Attribute of 
     *  News and Articles

     *
     *  Content type 
     *  string
     * @param newsSource Source for this article
     */
    public void setNewsSource(String newsSource);

    /**
     * Source for this article.
     *
     * 
     * 
     *
     *  
     * 
     * 
     *  
     *
     *  
     *
     * 
     * 
     *  
     *  
     *
     * 
     *
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     * 
     * 
     *  news_source

     *  Details 
     *  The source of news content.

     *  Example  <g:news_source>Journal</g:news_source>

     *  Attribute of 
     *  News and Articles

     *
     *  Content type 
     *  string
     * @return source for this article.
     */
    public String getNewsSource();

    /**
     * Number of pages in the article.
     *
     * 
     *
     * 
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     *
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  pages

     *  Details 
     *
     *  The number of pages in the publication.

     *  Example  <g:pages>18</g:pages>

     *  Attribute of 
     *  Reference Items, News and Articles

     *
     *  Content type 
     *  integer
     * @param pages Number of pages in the article
     */
    public void setPages(Integer pages);

    /**
     * Number of pages in the article.
     *
     * 
     *
     * 
     *  
     *
     * 
     * 
     *  
     *  
     * 
     *
     * 
     *  
     *  
     *
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *
     *  
     *  
     * 
     * 
     *  pages

     *  Details 
     *
     *  The number of pages in the publication.

     *  Example  <g:pages>18</g:pages>

     *  Attribute of 
     *  Reference Items, News and Articles

     *
     *  Content type 
     *  integer
     * @return Number of pages in the article
     */
    public Integer getPages();

    /**
     * Date article 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 article was published
     */
    public void setPublishDate(Date publishDate);

    /**
     *  Date article 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 article was published
     */
    public Date getPublishDate();
}

* author
* Details	* Author of the item.
* Example	<g:author>John Steinbeck</g:author>
* Attribute of	* Reference Items, News and Articles
* Content type	* string

* author
* Details	* Author of the item.
* Example	<g:author>John Steinbeck</g:author>
* Attribute of	* Reference Items, News and Articles
* Content type	* string

* news_source
* Details	* The source of news content.
* Example	<g:news_source>Journal</g:news_source>
* Attribute of	* News and Articles
* * Content type	* string

* news_source
* Details	* The source of news content.
* Example	<g:news_source>Journal</g:news_source>
* Attribute of	* News and Articles
* * Content type	* string

* pages
* Details	* * The number of pages in the publication.
* Example	<g:pages>18</g:pages>
* Attribute of	* Reference Items, News and Articles
* * Content type	* integer

* 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