org.sakaiproject.component.legacy.announcement
Class BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

java.lang.Object
  extended byorg.sakaiproject.component.legacy.message.BaseMessageService.BaseMessageHeaderEdit
      extended byorg.sakaiproject.component.legacy.announcement.BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit
All Implemented Interfaces:
AnnouncementMessageHeader, AnnouncementMessageHeaderEdit, AttachmentContainer, AttachmentContainerEdit, MessageHeader, MessageHeaderEdit
Enclosing class:
BaseAnnouncementService

public class BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit
extends BaseMessageService.BaseMessageHeaderEdit
implements AnnouncementMessageHeaderEdit

AnnouncementMessageHeaderEdit implementation


Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.service.legacy.message.MessageHeader
MessageHeader.MessageAccess
 
Field Summary
protected  String m_subject
          The subject for the announcement.
 
Fields inherited from class org.sakaiproject.component.legacy.message.BaseMessageService.BaseMessageHeaderEdit
m_access, m_attachments, m_date, m_draft, m_from, m_groups, m_id, m_message
 
Constructor Summary
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message msg, Element el)
          Construct, from an already existing XML DOM element.
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message msg, MessageHeader other)
          Construct as a copy of another header.
BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message msg, String id)
          Construct.
 
Method Summary
 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.component.legacy.message.BaseMessageService.BaseMessageHeaderEdit
addAttachment, addGroup, clearAttachments, getAccess, getAttachments, getDate, getDraft, getFrom, getGroups, getId, removeAttachment, removeGroup, replaceAttachments, setAccess, setDate, setDraft, setFrom
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.sakaiproject.service.legacy.message.MessageHeader
getAccess, getDate, getDraft, getFrom, getGroups, getId
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainer
getAttachments
 
Methods inherited from interface org.sakaiproject.service.legacy.message.MessageHeaderEdit
addGroup, removeGroup, setAccess, setDate, setDraft, setFrom
 
Methods inherited from interface org.sakaiproject.service.legacy.entity.AttachmentContainerEdit
addAttachment, clearAttachments, removeAttachment, replaceAttachments
 

Field Detail

m_subject

protected String m_subject
The subject for the announcement.

Constructor Detail

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

public BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(Message msg,
                                                                 String id)
Construct.

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

BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit

public BaseAnnouncementService.BaseAnnouncementMessageHeaderEdit(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(Message msg,
                                                                 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 AnnouncementMessageHeader
Returns:
The subject of the announcement.

setSubject

public void setSubject(String subject)
Set the subject of the announcement.

Specified by:
setSubject in interface 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 MessageHeader
Overrides:
toXml in class BaseMessageService.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.