org.sakaiproject.service.legacy.chat
Interface ChatMessage

All Superinterfaces:
Comparable, Entity, Message
All Known Subinterfaces:
ChatMessageEdit
All Known Implementing Classes:
BaseChatService.BaseChatMessageEdit

public interface ChatMessage
extends Message

ChatMessage is the Interface for a CHEF Chat message.

The chat 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.

Version:
$Revision: 632 $
Author:
University of Michigan, CHEF Software Development Team
See Also:
org.chefproject.service.generic.GenericChatService, org.chefproject.core.ChatChannel

Field Summary
 
Fields inherited from interface org.sakaiproject.service.legacy.entity.Entity
SEPARATOR
 
Method Summary
 ChatMessageHeader getChatHeader()
          A (ChatMessageHeader) cover for getHeader to access the chat message header.
 
Methods inherited from interface org.sakaiproject.service.legacy.message.Message
getBody, getHeader
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.Entity
getId, getProperties, getReference, getReference, getUrl, getUrl, toXml
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getChatHeader

public ChatMessageHeader getChatHeader()
A (ChatMessageHeader) cover for getHeader to access the chat message header.

Returns:
The chat message header.