Package org.sakaiproject.announcement.api

Interface AnnouncementMessage

All Superinterfaces:

Comparable, Entity, Message

All Known Subinterfaces:

AnnouncementMessageEdit

public interface AnnouncementMessage
extends Message

AnnouncementMessage is the Interface for a Sakai Announcement message.

The announcement message has header fields (from, date) and a body (text). Each message also has an id, unique within the channel. All fields are read only.

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
AnnouncementMessageHeader	getAnnouncementHeader()	A (AnnouncementMessageHeader) cover for getHeader to access the announcement message header.

Methods inherited from interface java.lang.Comparable

compareTo

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

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

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

getBody, getHeader

Method Detail

getAnnouncementHeader

AnnouncementMessageHeader getAnnouncementHeader()

A (AnnouncementMessageHeader) cover for getHeader to access the announcement message header.

Returns:

The announcement message header.