| org.sakaiproject.message.api.MessageHeaderEdit
| MessageHeaderEdit | | public interface MessageHeaderEdit extends MessageHeader,AttachmentContainerEdit(Code) | |
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 |
| Method Summary | |
| void | clearGroupAccess()
Remove any grouping for this message; the access mode reverts to channel and any groups are removed. | | 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. | | void | setGroupAccess(Collection groups)
Set these as the message's groups, replacing the access and groups already defined. |
| clearGroupAccess | | void clearGroupAccess() throws PermissionException(Code) | | Remove any grouping for this message; the access mode reverts to channel and any groups are removed.
throws:
PermissionException - if the end user does not have permission to do this. |
| setDate | | void setDate(Time date)(Code) | | Set the date/time the message was sent to the channel.
Parameters:
date - The date/time the message was sent to the channel. |
| setDraft | | void setDraft(boolean draft)(Code) | | Set the draft status of the message.
Parameters:
draft - True if the message is a draft, false if not. |
| setFrom | | void setFrom(User user)(Code) | | Set the User who sent the message to the channel.
Parameters:
user - The User who sent the message to the channel. |
| setGroupAccess | | void setGroupAccess(Collection groups) throws PermissionException(Code) | | Set these as the message's groups, replacing the access and groups already defined.
Parameters:
Collection - groups The colelction of Group objects to use for this message.
throws:
PermissionException - if the end user does not have permission to remove from the groups that would be removed or add to the groups that would be added. |
|
|