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