org.sakaiproject.service.legacy.message
Interface MessageHeaderEdit

All Superinterfaces:
AttachmentContainer, AttachmentContainerEdit, MessageHeader
All Known Subinterfaces:
AnnouncementMessageHeaderEdit, ChatMessageHeaderEdit, DiscussionMessageHeaderEdit, MailArchiveMessageHeaderEdit
All Known Implementing Classes:
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit, BaseChatService.BaseChatMessageHeaderEdit, BaseDiscussionService.BaseDiscussionMessageHeaderEdit, BaseMailArchiveService.BaseMailArchiveMessageHeaderEdit, BaseMessageService.BaseMessageHeaderEdit

public interface MessageHeaderEdit
extends MessageHeader, AttachmentContainerEdit

MessageHeader is the base Interface for a Sakai Message headers. Header fields common to all message service message headers are defined here.

Author:
Sakai Software Development Team

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.service.legacy.message.MessageHeader
MessageHeader.MessageAccess
 
Method Summary
 void addGroup(Group group)
          Add a Group to the list of groups for this message.
 void removeGroup(Group group)
          Remove this Group from the list of groups for this message.
 void setAccess(MessageHeader.MessageAccess access)
          Set the access mode for the message - how we compute who has access to the message.
 void setDate(Time date)
          Set the date/time the message was sent to the channel.
 void setDraft(boolean draft)
          Set the draft status of the message.
 void setFrom(User user)
          Set the User who sent the message to the channel.
 
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
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainerEdit
addAttachment, clearAttachments, removeAttachment, replaceAttachments
 

Method Detail

setDate

public void setDate(Time date)
Set the date/time the message was sent to the channel.

Parameters:
date - The date/time the message was sent to the channel.

setFrom

public void setFrom(User user)
Set the User who sent the message to the channel.

Parameters:
user - The User who sent the message to the channel.

setDraft

public void setDraft(boolean draft)
Set the draft status of the message.

Parameters:
draft - True if the message is a draft, false if not.

addGroup

public void addGroup(Group group)
              throws PermissionException
Add a Group to the list of groups for this message.

Parameters:
group - The Group to add to those for this message.
Throws:
PermissionException - if the end user does not have permission to do this.

removeGroup

public void removeGroup(Group group)
                 throws PermissionException
Remove this Group from the list of groups for this message.

Parameters:
group - The Group to remove from those for this message.
Throws:
PermissionException - if the end user does not have permission to do this.

setAccess

public void setAccess(MessageHeader.MessageAccess access)
Set the access mode for the message - how we compute who has access to the message.

Parameters:
access - The MessageAccess access mode for the message.