1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.business.rss;
35
36 import java.util.Date;
37 import java.util.List;
38
39
40 /**
41 * A feed resource.
42 * <ul>
43 * <li>title
44 * <li>link
45 * <li>description
46 * <li>language
47 * <li>date
48 * <li>image
49 * <li>items
50 * </ul>
51 */
52 public interface IFeedResource
53 {
54 /**
55 * Gets the feed title
56 * @return the title
57 */
58 String getTitle( );
59
60 /**
61 * Sets the feed title
62 * @param strTitle the title
63 */
64 void setTitle( String strTitle );
65
66 /**
67 * Gets the feed link - usually the site url.
68 * @return the link
69 */
70 String getLink( );
71
72 /**
73 * Sets the feed link
74 * @param strLink the link - usually the site url.
75 */
76 void setLink( String strLink );
77
78 /**
79 * Gets the feed description
80 * @return the description
81 */
82 String getDescription( );
83
84 /**
85 * Sets the description
86 * @param strDescription the description
87 */
88 void setDescription( String strDescription );
89
90 /**
91 * Gets the feed language
92 * @return the language
93 */
94 String getLanguage( );
95
96 /**
97 * Sets the language
98 * @param strLanguage the language
99 */
100 void setLanguage( String strLanguage );
101
102 /**
103 * Gets the feed items
104 * @return the items
105 */
106 List<IFeedResourceItem> getItems( );
107
108 /**
109 * Sets the feed items
110 * @param listItems the items
111 */
112 void setItems( List<IFeedResourceItem> listItems );
113
114 /**
115 * Gets the image
116 * @return the image
117 */
118 IFeedResourceImage getImage( );
119
120 /**
121 * Sets the image
122 * @param image the image
123 */
124 void setImage( IFeedResourceImage image );
125
126 /**
127 * Gets the item publishing date
128 * @return the date
129 */
130 Date getDate( );
131
132 /**
133 * Set the item publishing date
134 * @param date the date
135 */
136 void setDate( Date date );
137 }