01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/web/tags/sakai_2-4-1/news-api/api/src/java/org/sakaiproject/news/api/NewsItem.java $
03: * $Id: NewsItem.java 8312 2006-04-26 02:55:39Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.news.api;
21:
22: /**
23: * <p>
24: * NewsItem is the Interface for a Sakai News message.
25: * </p>
26: * <p>
27: * The news message has header fields (from, date) and a body (text). Each message also has an id, unique within the channel. All fields are read only.
28: * </p>
29: */
30: public interface NewsItem {
31: /**
32: * Access the title of the NewsItem.
33: *
34: * @return The title of the NewsItem.
35: */
36: public String getTitle();
37:
38: /**
39: * Access the description (or body) of the NewsItem.
40: *
41: * @return The description of the NewsItem.
42: */
43: public String getDescription();
44:
45: /**
46: * Access the time when the NewsItem was updated.
47: *
48: * @return The time when the NewsItem was updated.
49: */
50: public String getPubdate();
51:
52: /**
53: * Access the URL where the complete story can be found.
54: *
55: * @return The URL where the complete story can be found.
56: */
57: public String getLink();
58:
59: /**
60: * Set the title of the NewsItem.
61: *
62: * @param title
63: * The title of the NewsItem.
64: */
65: public void setTitle(String title);
66:
67: /**
68: * Set the description of the NewsItem.
69: *
70: * @param description
71: * The description of the NewsItem.
72: */
73: public void setDescription(String description);
74:
75: /**
76: * Set the time when the NewsItem was updated.
77: *
78: * @param pubdate
79: * The time when the NewsItem was updated.
80: */
81: public void setPubdate(String pubdate);
82:
83: /**
84: * Set the URL where the complete story can be found.
85: *
86: * @return link The URL where the complete story can be found.
87: */
88: public void setLink(String link);
89: }
|