01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/discussion/tags/sakai_2-4-1/discussion-api/api/src/java/org/sakaiproject/discussion/api/DiscussionMessageHeader.java $
03: * $Id: DiscussionMessageHeader.java 8232 2006-04-25 01:11:55Z 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.discussion.api;
21:
22: import org.sakaiproject.message.api.MessageHeader;
23:
24: /**
25: * <p>
26: * DiscussionMessageHeader is the Interface for a Sakai Discussion Message header.
27: * </p>
28: * <p>
29: * In addition to the usual body, from and time fields of MessageHeader, discussion messages have:
30: * </p>
31: * <p>
32: * Category: a selection from a limited set of strings which categorizes a message.
33: * </p>
34: * <p>
35: * Subject: an unrestricted user entered text that describes the message.
36: * </p>
37: * <p>
38: * ReplyTo: a message reference to which this message is a direct reply.
39: * </p>
40: * <p>
41: * Draft: a value that lets us have messages that are stored but are still in the process of being created and are not publically available yet.
42: * </p>
43: */
44: public interface DiscussionMessageHeader extends MessageHeader {
45: /**
46: * Access the subject of the discussion message.
47: *
48: * @return The subject of the discussion message.
49: */
50: public String getSubject();
51:
52: /**
53: * Access the category of the discussion message.
54: *
55: * @return The category of the discussion message.
56: */
57: public String getCategory();
58:
59: /**
60: * Access the local or resource id of the message this one is a reply to, used in threading.
61: *
62: * @return The id of the message this one is a reply to, used in threading, or null if none.
63: */
64: public String getReplyTo();
65: }
|