Package org.sakaiproject.announcement.api

Interface AnnouncementChannel<T extends AnnouncementMessage>

All Superinterfaces:

Entity, MessageChannel<T>

All Known Subinterfaces:

AnnouncementChannelEdit

public interface AnnouncementChannel<T extends AnnouncementMessage>
extends MessageChannel<T>

AnnouncementChannel is the extension to the MessageChanel interface for a Sakai Announcement service announcement channel.

Nested Class Summary

Nested classes/interfaces inherited from interface org.sakaiproject.entity.api.Entity

Entity.UrlType

Field Summary

Fields inherited from interface org.sakaiproject.entity.api.Entity

SEPARATOR

Method Summary

Modifier and Type	Method	Description
AnnouncementMessageEdit	addAnnouncementMessage()	a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
AnnouncementMessage	addAnnouncementMessage(String subject, boolean draft, List attachments, String body)	a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
AnnouncementMessageEdit	editAnnouncementMessage(String messageId)	A (AnnouncementMessageEdit) cover for editMessage.
AnnouncementMessage	getAnnouncementMessage(String messageId)	A (AnnouncementMessage) cover for getMessage to return a specific announcement channel message, as specified by message id.
void	removeAnnouncementMessage(String messageId)	A cover for removeMessage.

Methods inherited from interface org.sakaiproject.entity.api.Entity

getId, getProperties, getReference, getReference, getUrl, getUrl, toXml

Methods inherited from interface org.sakaiproject.message.api.MessageChannel

addMessage, allowAddChannelMessage, allowAddDraftMessage, allowAddMessage, allowEditMessage, allowGetMessages, allowRemoveMessage, cancelMessage, commitMessage, commitMessage, commitMessage, commitMessage_order, editMessage, getContext, getCount, getCount, getGroupsAllowAddMessage, getGroupsAllowGetMessage, getGroupsAllowRemoveMessage, getMessage, getMessages, getMessages, getMessagesPublic, mergeMessage, removeMessage, removeMessage

Method Detail

getAnnouncementMessage

AnnouncementMessage getAnnouncementMessage(String messageId)
                                    throws IdUnusedException,
                                           PermissionException

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.

Returns:

the AnnouncementMessage that has the specified id.

Throws:

IdUnusedException - If this name is not a defined message in this announcement channel.

PermissionException - If the user does not have any permissions to read the message.

editAnnouncementMessage

AnnouncementMessageEdit editAnnouncementMessage(String messageId)
                                         throws IdUnusedException,
                                                PermissionException,
                                                InUseException

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.

Returns:

the Message that has the specified id.

Throws:

IdUnusedException - If this name is not a defined message in this channel.

PermissionException - If the user does not have any permissions to read the message.

InUseException - if the current user does not have permission to mess with this user.

removeAnnouncementMessage

void removeAnnouncementMessage(String messageId)
                        throws PermissionException

A cover for removeMessage. Deletes the messages specified by the message id.

Parameters:

messageId - The id of the message to get.

Throws:

PermissionException - If the user does not have any permissions to delete the message.

addAnnouncementMessage

AnnouncementMessageEdit addAnnouncementMessage()
                                        throws PermissionException

a (AnnouncementMessage) cover for addMessage to add a new message to this channel. Must commitEdit() to make official, or cancelEdit() when done!

Returns:

The newly added message, locked for update.

Throws:

PermissionException - If the user does not have write permission to the channel.

addAnnouncementMessage

AnnouncementMessage addAnnouncementMessage(String subject,
                                           boolean draft,
                                           List attachments,
                                           String body)
                                    throws PermissionException

a (AnnouncementMessage) cover for addMessage to add a new message to this channel.

Parameters:

subject - The message header subject.

draft - The message header draft indication.

attachments - The message header attachments, a vector of Reference objects.

body - The message body.

Returns:

The newly added message.

Throws:

PermissionException - If the user does not have write permission to the channel.