| org.sakaiproject.announcement.api.AnnouncementChannel
| AnnouncementChannel | | public interface AnnouncementChannel extends MessageChannel(Code) | |
AnnouncementChannel is the extension to the MessageChanel interface for a Sakai Announcement service announcement channel.
|
| addAnnouncementMessage | | public AnnouncementMessageEdit addAnnouncementMessage() throws PermissionException(Code) | | a (AnnouncementMessage) cover for addMessage to add a new message to this channel. Must commitEdit() to make official, or cancelEdit() when done!
The newly added message, locked for update.
exception:
PermissionException - If the user does not have write permission to the channel. |
| addAnnouncementMessage | | public AnnouncementMessage addAnnouncementMessage(String subject, boolean draft, List attachments, String body) throws PermissionException(Code) | | a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
Parameters:
subject - The message header subject.
Parameters:
draft - The message header draft indication.
Parameters:
attachments - The message header attachments, a vector of Reference objects.
Parameters:
body - The message body. The newly added message.
exception:
PermissionException - If the user does not have write permission to the channel. |
| editAnnouncementMessage | | public AnnouncementMessageEdit editAnnouncementMessage(String messageId) throws IdUnusedException, PermissionException, InUseException(Code) | | A (AnnouncementMessageEdit) cover for editMessage. Return a specific channel message, as specified by message name, locked for update. Must commitEdit() to make official, or cancelEdit() when done!
Parameters:
messageId - The id of the message to get. the Message that has the specified id.
exception:
IdUnusedException - If this name is not a defined message in this channel.
exception:
PermissionException - If the user does not have any permissions to read the message.
exception:
InUseException - if the current user does not have permission to mess with this user. |
| getAnnouncementMessage | | public AnnouncementMessage getAnnouncementMessage(String messageId) throws IdUnusedException, PermissionException(Code) | | A (AnnouncementMessage) cover for getMessage to return a specific announcement channel message, as specified by message id.
Parameters:
messageId - The id of the message to get. the AnnouncementMessage that has the specified id.
exception:
IdUnusedException - If this name is not a defined message in this announcement channel.
exception:
PermissionException - If the user does not have any permissions to read the message. |
|
|