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.samples.module;
18  
19  import com.sun.syndication.feed.module.Module;
20  
21  import java.util.Date;
22  import java.util.List;
23  
24  /***
25   * Sample ModuleImpl Interface.
26   * <p>
27   * To show how to integrate a module in Rome.
28   * <p>
29   * @author Alejandro Abdelnur
30   */
31  public interface SampleModule extends Module {
32  
33      /***
34       * URI of the Sample ModuleImpl (http://rome.dev.java.net/module/foo/1.0).
35       *
36       */
37      public static final String URI = "http://rome.dev.java.net/module/sample/1.0";
38  
39      /***
40       * Returns the Sample module bar value.
41       * @return the bar value.
42       */
43      public String getBar();
44  
45      /***
46       * Sets the Sample module bar value.
47       * <p>
48       * @param bar the bar value, <b>null</b> if none.
49       *
50       */
51      public void setBar(String bar);
52  
53  
54      /***
55       * Returns the Sample module foos.
56       * <p>
57       * @return a list of String elements with the Sample module foos,
58       *         an empty list if none.
59       *
60       */
61      public List getFoos();
62  
63      /***
64       * Sets the Sample module foos.
65       * <p>
66       * @param foos the list of String elements with the Sample module foos to set,
67       *        an empty list or <b>null</b> if none.
68       *
69       */
70      public void setFoos(List foos);
71  
72  
73      /***
74       * Returns the Sample module date.
75       * <p>
76       * @return the Sample module date, <b>null</b> if none.
77       *
78       */
79      public Date getDate();
80  
81      /***
82       * Sets the Sample module date.
83       * <p>
84       * @param date the Sample module date to set, <b>null</b> if none.
85       *
86       */
87      public void setDate(Date date);
88  
89  
90  }