View Javadoc

1   package com.sun.syndication.feed.sse;
2   
3   import java.util.Date;
4   
5   /***
6    * <pre><sx:sharing></pre>Element within RSS <pre><channel></pre> or OPML <pre><head></pre>.
7    */
8   public class Sharing {
9       // whether subscribers MUST treat the item list as an ordered set
10      private Boolean ordered;
11      // expresses size of the window of change history kept by the published.
12      private Integer window;
13      // date after which updated items are included in the feed.
14      private Date since;
15      // date after which updated items are not included in the feed. 
16      private Date until;
17  
18      /***
19       * ordered An optional, Boolean attribute. If present and its value is "true" (lower-case), subscribers MUST treat
20       * the item list as an ordered set (see section 3.2). If this attribute is omitted or blank, it is assumed that this
21       * is an unordered feed.
22       *
23       * @return a Boolean indicating if subscribers must treat the item list as an ordered set.
24       */
25      public Boolean getOrdered() {
26          return ordered;
27      }
28  
29  
30      /***
31       * Set whether subscribers MUST tread the item list as an ordered set.
32       *
33       * @param ordered whether subscribers MUST tread the item list as an ordered set.
34       */
35      public void setOrdered(Boolean ordered) {
36          this.ordered = ordered;
37      }
38  
39      /***
40       * Provides an Integer that expresses the size of the window of change history kept by the publisher. Subscribers
41       * MAY use this value to determine the frequency with which they must read a feed.
42       *
43       * @return an Integer that expresses the size of the window of change history kept by the publisher.
44       */
45      public Integer getWindow() {
46          return window;
47      }
48  
49      /***
50       * Set an Integer that expresses the size of the window of change history kept by the publisher.
51       *
52       * @param window an Integer that expresses the size of the window of change history kept by the publisher.
53       */
54      public void setWindow(Integer window) {
55          this.window = window;
56      }
57  
58      /***
59       * since An optional date-time attribute. All items updated on or after this date-time are included in the feed. If
60       * not present or null, the "beginning of time" is assumed and the feed contains the node's complete item set as of
61       * the until date-time.
62       *
63       * @return An optional date-time attribute.
64       */
65      public Date getSince() {
66          return since;
67      }
68  
69      /***
70       * Sets the optional date-time attribute where all items updated on or after this date-time are included in the
71       * feed.
72       *
73       * @param since An optional date-time attribute.
74       */
75      public void setSince(Date since) {
76          this.since = since;
77      }
78  
79      /***
80       * until An optional date-time attribute. Items updated after this date are not included in the feed. The publisher
81       * must guarantee that the value of until will increase if any items in the feed are updated. If this attribute is
82       * omitted or blank, the subscriber cannot make assumptions about when the feed was updated.
83       *
84       * @return the date where items updated after this date are not included in the feed.
85       */
86      public Date getUntil() {
87          return until;
88      }
89  
90      /***
91       * Set the date where items updated after this date are not included in the feed.
92       *
93       * @param until the date where items updated after this date are not included in the feed.
94       */
95      public void setUntil(Date until) {
96          this.until = until;
97      }
98  }