1 /*
2 * Copyright (c) 2002-2022, City of 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 * A feed resource.
41 * <ul>
42 * <li>title
43 * <li>link
44 * <li>description
45 * <li>language
46 * <li>date
47 * <li>image
48 * <li>items
49 * </ul>
50 */
51 public interface IFeedResource
52 {
53 /**
54 * Gets the feed title
55 *
56 * @return the title
57 */
58 String getTitle( );
59
60 /**
61 * Sets the feed title
62 *
63 * @param strTitle
64 * the title
65 */
66 void setTitle( String strTitle );
67
68 /**
69 * Gets the feed link - usually the site url.
70 *
71 * @return the link
72 */
73 String getLink( );
74
75 /**
76 * Sets the feed link
77 *
78 * @param strLink
79 * the link - usually the site url.
80 */
81 void setLink( String strLink );
82
83 /**
84 * Gets the feed description
85 *
86 * @return the description
87 */
88 String getDescription( );
89
90 /**
91 * Sets the description
92 *
93 * @param strDescription
94 * the description
95 */
96 void setDescription( String strDescription );
97
98 /**
99 * Gets the feed language
100 *
101 * @return the language
102 */
103 String getLanguage( );
104
105 /**
106 * Sets the language
107 *
108 * @param strLanguage
109 * the language
110 */
111 void setLanguage( String strLanguage );
112
113 /**
114 * Gets the feed items
115 *
116 * @return the items
117 */
118 List<IFeedResourceItem> getItems( );
119
120 /**
121 * Sets the feed items
122 *
123 * @param listItems
124 * the items
125 */
126 void setItems( List<IFeedResourceItem> listItems );
127
128 /**
129 * Gets the image
130 *
131 * @return the image
132 */
133 IFeedResourceImage getImage( );
134
135 /**
136 * Sets the image
137 *
138 * @param image
139 * the image
140 */
141 void setImage( IFeedResourceImage image );
142
143 /**
144 * Gets the item publishing date
145 *
146 * @return the date
147 */
148 Date getDate( );
149
150 /**
151 * Set the item publishing date
152 *
153 * @param date
154 * the date
155 */
156 void setDate( Date date );
157 }