KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > newsletter > I_CmsNewsletterContent


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/newsletter/I_CmsNewsletterContent.java,v $
3  * Date : $Date: 2006/03/27 14:52:48 $
4  * Version: $Revision: 1.2 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (C) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */

31
32 package org.opencms.newsletter;
33
34 /**
35  * Every {@link I_CmsNewsletter} contains a list of I_CmsNewsletterContent objects. <p>
36  *
37  * These objects have an order, by which the newsletter content is sorted, the type either
38  * {@link org.opencms.newsletter.CmsNewsletterContentType#TYPE_HTML} or
39  * {@link org.opencms.newsletter.CmsNewsletterContentType#TYPE_TEXT}.
40  */

41 public interface I_CmsNewsletterContent extends Comparable JavaDoc {
42
43     /**
44      * Returns the channel.<p>
45      *
46      * @return the channel
47      */

48     String JavaDoc getChannel();
49
50     /**
51      * Returns the content.<p>
52      *
53      * @return the content
54      */

55     String JavaDoc getContent();
56
57     /**
58      * Returns the order of this content in it's channel.<p>
59      *
60      * @return the order of this content in it's channel
61      */

62     int getOrder();
63
64     /**
65      * Returns the type.<p>
66      *
67      * @return the type
68      */

69     CmsNewsletterContentType getType();
70 }
Popular Tags