Source code: com/sun/syndication/feed/module/SyModule.java
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.Date;
20
21 /**
22 * Syndication ModuleImpl.
23 * <p>
24 * @see <a href="http://web.resource.org/rss/1.0/modules/syndication/">Syndication module</a>.
25 * @author Alejandro Abdelnur
26 *
27 */
28 public interface SyModule extends Module {
29
30 /**
31 * URI of the Syndication ModuleImpl (http://purl.org/rss/1.0/modules/syndication/).
32 *
33 */
34 String URI = "http://purl.org/rss/1.0/modules/syndication/";
35
36 String HOURLY = new String("hourly");
37 String DAILY = new String("daily");
38 String WEEKLY = new String("weekly");
39 String MONTHLY = new String("monthly");
40 String YEARLY = new String("yearly");
41
42 /**
43 * Returns the Syndication module update period.
44 * <p>
45 * @return the Syndication module update period, <b>null</b> if none.
46 *
47 */
48 String getUpdatePeriod();
49
50 /**
51 * Sets the Syndication module update period.
52 * <p>
53 * @param updatePeriod the Syndication module update period to set, <b>null</b> if none.
54 *
55 */
56 void setUpdatePeriod(String updatePeriod);
57
58 /**
59 * Returns the Syndication module update frequency.
60 * <p>
61 * @return the Syndication module update frequency, <b>null</b> if none.
62 *
63 */
64 int getUpdateFrequency();
65
66 /**
67 * Sets the Syndication module update frequency.
68 * <p>
69 * @param updateFrequency the Syndication module update frequency to set, <b>null</b> if none.
70 *
71 */
72 void setUpdateFrequency(int updateFrequency);
73
74 /**
75 * Returns the Syndication module update base date.
76 * <p>
77 * @return the Syndication module update base date, <b>null</b> if none.
78 *
79 */
80 Date getUpdateBase();
81
82 /**
83 * Sets the Syndication module update base date.
84 * <p>
85 * @param updateBase the Syndication module update base date to set, <b>null</b> if none.
86 *
87 */
88 void setUpdateBase(Date updateBase);
89
90 }