org.sakaiproject.announcement.impl

Class BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

java.lang.Object

org.sakaiproject.message.util.BaseMessage.BaseMessageHeaderEdit

org.sakaiproject.announcement.impl.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

All Implemented Interfaces:

org.sakaiproject.announcement.api.AnnouncementMessageHeader, org.sakaiproject.announcement.api.AnnouncementMessageHeaderEdit, org.sakaiproject.entity.api.AttachmentContainer, org.sakaiproject.entity.api.AttachmentContainerEdit, org.sakaiproject.message.api.MessageHeader, org.sakaiproject.message.api.MessageHeaderEdit

Enclosing class:

BaseAnnouncementService

public class BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit
extends org.sakaiproject.message.util.BaseMessage.BaseMessageHeaderEdit
implements org.sakaiproject.announcement.api.AnnouncementMessageHeaderEdit

AnnouncementMessageHeaderEdit implementation

Nested Class Summary

Nested classes/interfaces inherited from interface org.sakaiproject.message.api.MessageHeader

org.sakaiproject.message.api.MessageHeader.MessageAccess

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_subject The subject for the announcement.

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

m_access, m_attachments, m_date, m_draft, m_from, m_groups, m_id, m_message, m_message_order

Constructor Summary

Constructors

Constructor and Description
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg, Element el) Construct, from an already existing XML DOM element.
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg, org.sakaiproject.message.api.MessageHeader other) Construct as a copy of another header.
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg, String id) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSubject() Access the subject of the announcement.
void	setSubject(String subject) Set the subject of the announcement.
Element	toXml(Document doc, Stack stack) Serialize the resource into XML, adding an element to the doc under the top of the stack element.

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

addAttachment, clearAttachments, clearGroupAccess, getAccess, getAttachments, getDate, getDraft, getFrom, getGroupObjects, getGroups, getId, getMessage_order, removeAttachment, replaceAttachments, setDate, setDraft, setFrom, setGroupAccess, setMessage_order

Methods inherited from class java.lang.Object

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

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

clearGroupAccess, setDate, setDraft, setFrom, setGroupAccess, setMessage_order

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

getAccess, getDate, getDraft, getFrom, getGroupObjects, getGroups, getId, getMessage_order

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

addAttachment, clearAttachments, removeAttachment, replaceAttachments

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

getAttachments

Field Detail

m_subject

protected String m_subject

The subject for the announcement.

Constructor Detail

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

public BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg,
                                                         String id)

Construct.

Parameters:

id - The unique (within the channel) message id.

from - The User who sent the message to the channel.

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

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

public BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg,
                                                         Element el)

Construct, from an already existing XML DOM element.

Parameters:

el - The header in XML in a DOM element.

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

public BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(org.sakaiproject.message.api.Message msg,
                                                         org.sakaiproject.message.api.MessageHeader other)

Construct as a copy of another header.

Parameters:

other - The other message header to copy.

Method Detail

getSubject

public String getSubject()

Access the subject of the announcement.

Specified by:

getSubject in interface org.sakaiproject.announcement.api.AnnouncementMessageHeader

Returns:

The subject of the announcement.

setSubject

public void setSubject(String subject)

Set the subject of the announcement.

Specified by:

setSubject in interface org.sakaiproject.announcement.api.AnnouncementMessageHeaderEdit

Parameters:

subject - The subject of the announcement.

toXml

public Element toXml(Document doc,
            Stack stack)

Serialize the resource into XML, adding an element to the doc under the top of the stack element.

Specified by:

toXml in interface org.sakaiproject.message.api.MessageHeader

Overrides:

toXml in class org.sakaiproject.message.util.BaseMessage.BaseMessageHeaderEdit

Parameters:

doc - The DOM doc to contain the XML (or null for a string return).

stack - The DOM elements, the top of which is the containing element of the new "resource" element.

Returns:

The newly added element.