ResourceRss.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.business.rss;

/**
 * ResourceRss that provides the resources rss. Implementations should override {@link #getFeed()}.
 */
public abstract class ResourceRss implements IResourceRss
{
    private int _nId;
    private String _strEncoding;
    private IResourceRssType _taskType;
    private String _strName;
    private String _strDescription;
    private String _strFeedType;
    private int _nMaxItems;

    /**
     * Get the rss id
     * 
     * @return the rss Id
     */
    @Override
    public int getId( )
    {
        return _nId;
    }

    /**
     * Set the rss id
     * 
     * @param nId
     *            the rss id
     */
    @Override
    public void setId( int nId )
    {
        _nId = nId;
    }

    /**
     * Get Rss resource Description
     * 
     * @return the description
     */
    @Override
    public String getDescription( )
    {
        return _strDescription;
    }

    /**
     * Set the RSS resource description
     * 
     * @param strDescription
     *            the description
     */
    @Override
    public void setDescription( String strDescription )
    {
        _strDescription = strDescription;
    }

    /**
     * Get The RSS resource name
     * 
     * @return the name
     */
    @Override
    public String getName( )
    {
        return _strName;
    }

    /**
     * Set the RSS resource name
     * 
     * @param strName
     *            the name
     */
    @Override
    public void setName( String strName )
    {
        _strName = strName;
    }

    /**
     * Get the RSS Resource Type
     * 
     * @return the ResourceRssType Object
     */
    @Override
    public IResourceRssType getResourceRssType( )
    {
        return _taskType;
    }

    /**
     * Set the ResourceRssType object.
     *
     * @param taskType
     *            the new resource rss type
     */
    @Override
    public void setResourceRssType( IResourceRssType taskType )
    {
        _taskType = taskType;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public String getFeedType( )
    {
        return _strFeedType;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public void setFeedType( String strFeedType )
    {
        _strFeedType = strFeedType;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public String getEncoding( )
    {
        return _strEncoding;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public void setEncoding( String strEncoding )
    {
        _strEncoding = strEncoding;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public int getMaxItems( )
    {
        return _nMaxItems;
    }

    /**
     *
     * {@inheritDoc}
     */
    @Override
    public void setMaxItems( int nMaxItems )
    {
        _nMaxItems = nMaxItems;
    }

    /**
     * Returns <code>null</code>. This method should be overriden.
     *
     * @return the feed
     */
    @Override
    public IFeedResource getFeed( )
    {
        return null;
    }
}