• Home
• com.rometools
• rome-modules
• 1.6.0
• source code
• ScholarlyArticle.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.rometools.modules.base.ScholarlyArticle Maven / Gradle / Ivy

/*
 * ScholarlyArticle.java
 *
 * Created on November 16, 2005, 1:55 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.rometools.modules.base;

import java.util.Date;

/**
 * This is an interface for the GoogleBase plug in that exposes methods used for Scholarly
 * publication, research studies and reference materials.
 *
 * @author Robert "kebernet" Cooper
 * @version $Revision: 1.2 $
 */
public interface ScholarlyArticle 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();

    /**
     * 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();

    /**
     * Name of the publication.
     *
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
 publication_name
 Details

     *
     * Name of the publication.
 Example
 <g:publication_name> Journal of Appropriate
     * Technology</g:publication_name>
 Attribute of
 Research studies and publications

     *
     * Content type
 string
     *
     * @param publicationName Name of the publication.
     */
    public void setPublicationName(String publicationName);

    /**
     * Name of the publication.
     *
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
 publication_name
 Details

     *
     * Name of the publication.
 Example
 <g:publication_name> Journal of Appropriate
     * Technology</g:publication_name>
 Attribute of
 Research studies and publications

     *
     * Content type
 string
     *
     * @return Name of the publication.
     */
    public String getPublicationName();

    /**
     * Volume of the publication.
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     * 
 publication_volume
 Details

     *
     * Volume of the publication.
 Example
<g:publication_volume>VI</g:publication_volume>
 Attribute of
 Reference Items
 Content type
 string
     *
     * @param publicationVolume Volume of the publication.
     */
    public void setPublicationVolume(String publicationVolume);

    /**
     * Volume of the publication.
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     * 
     *
     * 
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     *
     * 
     * 
     *
     * 
     * 
     * 
     * 
 publication_volume
 Details

     *
     * Volume of the publication.
 Example
<g:publication_volume>VI</g:publication_volume>
 Attribute of
 Reference Items
 Content type
 string
     *
     * @return Volume of the publication.
     */
    public String getPublicationVolume();

    /**
     * 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();
}