org.sakaiproject.service.legacy.discussion
Interface DiscussionMessageHeader

All Superinterfaces:
AttachmentContainer, MessageHeader
All Known Subinterfaces:
DiscussionMessageHeaderEdit
All Known Implementing Classes:
BaseDiscussionService.BaseDiscussionMessageHeaderEdit

public interface DiscussionMessageHeader
extends MessageHeader

DiscussionMessageHeader is the Interface for a CHEF Discussion Message header.

In addition to the usual body, from and time fields of MessageHeader, discussion messages have:

Category: a selection from a limited set of strings which categorizes a message.

Subject: an unrestricted user entered text that describes the message.

ReplyTo: a message reference to which this message is a direct reply.

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.

Version:
$Revision: 632 $
Author:
University of Michigan, CHEF Software Development Team

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.service.legacy.message.MessageHeader
MessageHeader.MessageAccess
 
Method Summary
 String getCategory()
          Access the category of the discussion message.
 String getReplyTo()
          Access the local or resource id of the message this one is a reply to, used in threading.
 String getSubject()
          Access the subject of the discussion message.
 
Methods inherited from interface org.sakaiproject.service.legacy.message.MessageHeader
getAccess, getDate, getDraft, getFrom, getGroups, getId, toXml
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainer
getAttachments
 

Method Detail

getSubject

public String getSubject()
Access the subject of the discussion message.

Returns:
The subject of the discussion message.

getCategory

public String getCategory()
Access the category of the discussion message.

Returns:
The category of the discussion message.

getReplyTo

public String getReplyTo()
Access the local or resource id of the message this one is a reply to, used in threading.

Returns:
The id of the message this one is a reply to, used in threading, or null if none.