1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package com.sun.syndication.feed.module;
18
19 import com.sun.syndication.common.Enum;
20
21 import java.util.Date;
22
23 /***
24 * Syndication Module.
25 * <p>
26 * @see <a href="http://web.resource.org/rss/1.0/modules/syndication/">Syndication module</a>.
27 * @author Alejandro Abdelnur
28 *
29 */
30 public interface SyModuleI extends ModuleI {
31
32 /***
33 * URI of the Syndication Module (http://purl.org/rss/1.0/modules/syndication/).
34 *
35 */
36 String URI = "http://purl.org/rss/1.0/modules/syndication/";
37
38 /***
39 * Enumeration type for the 'update period' property of the Syndication module.
40 * <p>
41 * @author Alejandro Abdelnur
42 *
43 */
44 public static class Period extends Enum {
45
46 private Period(String name) {
47 super(name);
48 }
49
50 }
51
52 Period HOURLY = new Period("hourly");
53 Period DAILY = new Period("daily");
54 Period WEEKLY = new Period("weekly");
55 Period MONTHLY = new Period("monthly");
56 Period YEARLY = new Period("yearly");
57
58 /***
59 * Returns the Syndication module update period.
60 * <p>
61 * @return the Syndication module update period, <b>null</b> if none.
62 *
63 */
64 Period getUpdatePeriod();
65
66 /***
67 * Sets the Syndication module update period.
68 * <p>
69 * @param updatePeriod the Syndication module update period to set, <b>null</b> if none.
70 *
71 */
72 void setUpdatePeriod(Period updatePeriod);
73
74 /***
75 * Returns the Syndication module update frequency.
76 * <p>
77 * @return the Syndication module update frequency, <b>null</b> if none.
78 *
79 */
80 int getUpdateFrequency();
81
82 /***
83 * Sets the Syndication module update frequency.
84 * <p>
85 * @param updateFrequency the Syndication module update frequency to set, <b>null</b> if none.
86 *
87 */
88 void setUpdateFrequency(int updateFrequency);
89
90 /***
91 * Returns the Syndication module update base date.
92 * <p>
93 * @return the Syndication module update base date, <b>null</b> if none.
94 *
95 */
96 Date getUpdateBase();
97
98 /***
99 * Sets the Syndication module update base date.
100 * <p>
101 * @param updateBase the Syndication module update base date to set, <b>null</b> if none.
102 *
103 */
104 void setUpdateBase(Date updateBase);
105
106 }