View Javadoc

1   /*
2    * Copyright 2004 Sun Microsystems, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   */
17  package com.sun.syndication.feed.module;
18  
19  import java.util.List;
20  import java.util.Date;
21  
22  /***
23   * Dublin Core Module.
24   * <p>
25   * @see <a href="http://web.resource.org/rss/1.0/modules/dc/">Dublin Core module</a>.
26   * @author Alejandro Abdelnur
27   *
28   */
29  public interface DCModuleI extends ModuleI {
30  
31      /***
32       * URI of the Dublin Core Module (http://purl.org/dc/elements/1.1/).
33       *
34       */
35      String URI = "http://purl.org/dc/elements/1.1/";
36  
37      /***
38       * Returns the DublinCore module title.
39       * <p>
40       * @return the DublinCore module title, <b>null</b> if none.
41       *
42       */
43      String getTitle();
44  
45      /***
46       * Sets the DublinCore module title.
47       * <p>
48       * @param title the DublinCore module title to set, <b>null</b> if none.
49       *
50       */
51      void setTitle(String title);
52  
53      /***
54       * Returns the DublinCore module creator.
55       * <p>
56       * @return the DublinCore module creator, <b>null</b> if none.
57       *
58       */
59      String getCreator();
60  
61      /***
62       * Sets the DublinCore module creator.
63       * <p>
64       * @param creator the DublinCore module creator to set, <b>null</b> if none.
65       *
66       */
67      void setCreator(String creator);
68  
69      /***
70       * Returns the DublinCore module subjects.
71       * <p>
72       * @return a list of DCSubjectI elements with the DublinCore module subjects,
73       *         an empty list if none.
74       *
75       */
76      List getSubjects();
77  
78      /***
79       * Sets the DublinCore module subjects.
80       * <p>
81       * @param subjects the list of DCSubjectI elements with the DublinCore module subjects to set,
82       *        an empty list or <b>null</b> if none.
83       *
84       */
85      void setSubjects(List subjects);
86  
87      /***
88       * Returns the DublinCore module description.
89       * <p>
90       * @return the DublinCore module description, <b>null</b> if none.
91       *
92       */
93      String getDescription();
94  
95      /***
96       * Sets the DublinCore module description.
97       * <p>
98       * @param description the DublinCore module description to set, <b>null</b> if none.
99       *
100      */
101     void setDescription(String description);
102 
103     /***
104      * Returns the DublinCore module publisher.
105      * <p>
106      * @return the DublinCore module publisher, <b>null</b> if none.
107      *
108      */
109     String getPublisher();
110 
111     /***
112      * Sets the DublinCore module publisher.
113      * <p>
114      * @param publisher the DublinCore module publisher to set, <b>null</b> if none.
115      *
116      */
117     void setPublisher(String publisher);
118 
119     /***
120      * Returns the DublinCore module contributors.
121      * <p>
122      * @return a list of String elements with the DublinCore module contributors,
123      *         an empty list if none.
124      *
125      */
126     List getContributors();
127 
128     /***
129      * Sets the DublinCore module contributors.
130      * <p>
131      * @param contributors the list of String elements with the DublinCore module contributors to set,
132      *        an empty list or <b>null</b> if none.
133      *
134      */
135     void setContributors(List contributors);
136 
137     /***
138      * Returns the DublinCore module date.
139      * <p>
140      * @return the DublinCore module date, <b>null</b> if none.
141      *
142      */
143     Date getDate();
144 
145     /***
146      * Sets the DublinCore module date.
147      * <p>
148      * @param date the DublinCore module date to set, <b>null</b> if none.
149      *
150      */
151     void setDate(Date date);
152 
153     /***
154      * Returns the DublinCore module type.
155      * <p>
156      * @return the DublinCore module type, <b>null</b> if none.
157      *
158      */
159     String getType();
160 
161     /***
162      * Sets the DublinCore module type.
163      * <p>
164      * @param type the DublinCore module type to set, <b>null</b> if none.
165      *
166      */
167     void setType(String type);
168 
169     /***
170      * Returns the DublinCore module format.
171      * <p>
172      * @return the DublinCore module format, <b>null</b> if none.
173      *
174      */
175     String getFormat();
176 
177     /***
178      * Sets the DublinCore module format.
179      * <p>
180      * @param format the DublinCore module format to set, <b>null</b> if none.
181      *
182      */
183     void setFormat(String format);
184 
185     /***
186      * Returns the DublinCore module identifier.
187      * <p>
188      * @return the DublinCore module identifier, <b>null</b> if none.
189      *
190      */
191     String getIdentifier();
192 
193     /***
194      * Sets the DublinCore module identifier.
195      * <p>
196      * @param identifier the DublinCore module identifier to set, <b>null</b> if none.
197      *
198      */
199     void setIdentifier(String identifier);
200 
201     /***
202      * Returns the DublinCore module source.
203      * <p>
204      * @return the DublinCore module source, <b>null</b> if none.
205      *
206      */
207     String getSource();
208 
209     /***
210      * Sets the DublinCore module source.
211      * <p>
212      * @param source the DublinCore module source to set, <b>null</b> if none.
213      *
214      */
215     void setSource(String source);
216 
217     /***
218      * Returns the DublinCore module language.
219      * <p>
220      * @return the DublinCore module language, <b>null</b> if none.
221      *
222      */
223     String getLanguage();
224 
225     /***
226      * Sets the DublinCore module language.
227      * <p>
228      * @param language the DublinCore module language to set, <b>null</b> if none.
229      *
230      */
231     void setLanguage(String language);
232 
233     /***
234      * Returns the DublinCore module relation.
235      * <p>
236      * @return the DublinCore module relation, <b>null</b> if none.
237      *
238      */
239     String getRelation();
240 
241     /***
242      * Sets the DublinCore module relation.
243      * <p>
244      * @param relation the DublinCore module relation to set, <b>null</b> if none.
245      *
246      */
247     void setRelation(String relation);
248 
249     /***
250      * Returns the DublinCore module coverage.
251      * <p>
252      * @return the DublinCore module coverage, <b>null</b> if none.
253      *
254      */
255     String getCoverage();
256 
257     /***
258      * Sets the DublinCore module coverage.
259      * <p>
260      * @param coverage the DublinCore module coverage to set, <b>null</b> if none.
261      *
262      */
263     void setCoverage(String coverage);
264 
265     /***
266      * Returns the DublinCore module rights.
267      * <p>
268      * @return the DublinCore module rights, <b>null</b> if none.
269      *
270      */
271     String getRights();
272 
273     /***
274      * Sets the DublinCore module rights.
275      * <p>
276      * @param rights the DublinCore module rights to set, <b>null</b> if none.
277      *
278      */
279     void setRights(String rights);
280 
281 }