001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.newsletter;
029
030/**
031 * Every {@link I_CmsNewsletter} contains a list of I_CmsNewsletterContent objects. <p>
032 *
033 * These objects have an order, by which the newsletter content is sorted, the type either
034 * {@link org.opencms.newsletter.CmsNewsletterContentType#TYPE_HTML} or
035 * {@link org.opencms.newsletter.CmsNewsletterContentType#TYPE_TEXT}.
036 */
037public interface I_CmsNewsletterContent extends Comparable<I_CmsNewsletterContent> {
038
039    /**
040     * Returns the channel.<p>
041     *
042     * @return the channel
043     */
044    String getChannel();
045
046    /**
047     * Returns the content.<p>
048     *
049     * @return the content
050     */
051    String getContent();
052
053    /**
054     * Returns the order of this content in it's channel.<p>
055     *
056     * @return the order of this content in it's channel
057     */
058    int getOrder();
059
060    /**
061     * Returns the type.<p>
062     *
063     * @return the type
064     */
065    CmsNewsletterContentType getType();
066}