org.sakaiproject.announcement.impl

Class BaseAnnouncementService.BaseAnnouncementChannelEdit

java.lang.Object

java.util.Observable

org.sakaiproject.message.util.BaseMessage.BaseMessageChannelEdit<AnnouncementMessageEdit>

org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementChannelEdit

All Implemented Interfaces:

EventListener, AnnouncementChannel<AnnouncementMessageEdit>, AnnouncementChannelEdit, Edit, Entity, MessageChannel<AnnouncementMessageEdit>, MessageChannelEdit<AnnouncementMessageEdit>, SessionBindingListener

Enclosing class:

BaseAnnouncementService

public class BaseAnnouncementService.BaseAnnouncementChannelEdit
extends BaseMessage.BaseMessageChannelEdit<AnnouncementMessageEdit>
implements AnnouncementChannelEdit

AnnouncementChannel implementation

Field Summary

Fields inherited from class org.sakaiproject.message.util.BaseMessage.BaseMessageChannelEdit

m_active, m_context, m_event, m_id, m_isRemoved, m_properties

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

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BaseAnnouncementChannelEdit(Element el) Construct from a channel (and possibly messages) already defined in XML in a DOM tree.
BaseAnnouncementChannelEdit(MessageChannel other) Construct as a copy of another message.
BaseAnnouncementChannelEdit(String ref) Construct with a reference.

Method Summary

Modifier and Type	Method and Description
AnnouncementMessageEdit	addAnnouncementMessage() A (AnnouncementMessageEdit) cover for addMessage.
AnnouncementMessage	addAnnouncementMessage(String subject, boolean draft, List attachments, String body) a (AnnouncementMessage) cover for addMessage to add a new message to this channel.
void	commitMessage(MessageEdit edit, int priority, String invokee)
AnnouncementMessageEdit	editAnnouncementMessage(String messageId) A (AnnouncementMessageEdit) cover for editMessage.
AnnouncementMessage	getAnnouncementMessage(String messageId) Return a specific announcement channel message, as specified by message name.
List	getMessages(Filter filter, boolean ascending) Return a list of all or filtered messages in the channel.
void	removeAnnouncementMessage(String messageId) A cover for removeMessage.

Methods inherited from class org.sakaiproject.message.util.BaseMessage.BaseMessageChannelEdit

activate, addMessage, allowAddChannelMessage, allowAddDraftMessage, allowAddMessage, allowEditMessage, allowEditMessage, allowGetMessages, allowRemoveMessage, cancelMessage, closeEdit, commitDraftChanges, commitMessage_order, commitMessage, commitMessage, editMessage, filterGroupAccess, finalize, findFilterMessages, findMessage, findMessages, getContext, getCount, getCount, getEvent, getGroupsAllowAddMessage, getGroupsAllowFunction, getGroupsAllowGetMessage, getGroupsAllowRemoveMessage, getId, getMessage, getMessages, getMessagesPublic, getProperties, getPropertiesEdit, getReference, getReference, getUrl, getUrl, groupCollectionContainsRefString, isActiveEdit, mergeMessage, removeFromFindMessagesCache, removeMessage, removeMessage, setEvent, setRemoved, startNotifyThread, toXml, valueBound, valueUnbound

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

getPropertiesEdit, isActiveEdit

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

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

Constructor Detail

BaseAnnouncementChannelEdit

public BaseAnnouncementChannelEdit(String ref)

Construct with a reference.

Parameters:

ref - The channel reference.

BaseAnnouncementChannelEdit

public BaseAnnouncementChannelEdit(MessageChannel other)

Construct as a copy of another message.

Parameters:

other - The other message to copy.

BaseAnnouncementChannelEdit

public BaseAnnouncementChannelEdit(Element el)

Construct from a channel (and possibly messages) already defined in XML in a DOM tree. The Channel is added to storage.

Parameters:

el - The XML DOM element defining the channel.

Method Detail

getAnnouncementMessage

public AnnouncementMessage getAnnouncementMessage(String messageId)
                                           throws IdUnusedException,
                                                  PermissionException

Return a specific announcement channel message, as specified by message name.

Specified by:

getAnnouncementMessage in interface AnnouncementChannel<AnnouncementMessageEdit>

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.

getMessages

public List getMessages(Filter filter,
                        boolean ascending)
                 throws PermissionException

Return a list of all or filtered messages in the channel. The order in which the messages will be found in the iteration is by date, oldest first if ascending is true, newest first if ascending is false.

Specified by:

getMessages in interface MessageChannel<AnnouncementMessageEdit>

Overrides:

getMessages in class BaseMessage.BaseMessageChannelEdit<AnnouncementMessageEdit>

Parameters:

filter - A filtering object to accept messages, or null if no filtering is desired.

ascending - Order of messages, ascending if true, descending if false

Returns:

a list on channel Message objects or specializations of Message objects (may be empty).

Throws:

PermissionException - if the user does not have read permission to the channel.

editAnnouncementMessage

public 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!

Specified by:

editAnnouncementMessage in interface AnnouncementChannel<AnnouncementMessageEdit>

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

public void removeAnnouncementMessage(String messageId)
                               throws PermissionException

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

Specified by:

removeAnnouncementMessage in interface AnnouncementChannel<AnnouncementMessageEdit>

Parameters:

messageId - The id of the message to get.

Throws:

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

addAnnouncementMessage

public AnnouncementMessageEdit addAnnouncementMessage()
                                               throws PermissionException

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

Specified by:

addAnnouncementMessage in interface AnnouncementChannel<AnnouncementMessageEdit>

Returns:

The newly added message, locked for update.

Throws:

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

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

Specified by:

addAnnouncementMessage in interface AnnouncementChannel<AnnouncementMessageEdit>

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.

commitMessage

public void commitMessage(MessageEdit edit,
                          int priority,
                          String invokee)

Specified by:

commitMessage in interface MessageChannel<AnnouncementMessageEdit>

Overrides:

commitMessage in class BaseMessage.BaseMessageChannelEdit<AnnouncementMessageEdit>