| org.sakaiproject.message.api.MessageHeader
| MessageHeader | | public interface MessageHeader extends AttachmentContainer(Code) | |
MessageHeader is the base Interface for a Sakai Message headers. Header fields common to all message service message headers are defined here.
|
| Inner Class :public class MessageAccess | |
| Method Summary | |
| MessageAccess | getAccess()
Access the access mode for the message - how we compute who has access to the message. | | Time | getDate()
Access the date/time the message was sent to the channel. | | boolean | getDraft()
Access the draft status of the message. | | User | getFrom()
Access the User who sent the message to the channel. | | Collection | getGroupObjects()
Access the groups, as Group objects, defined for this message. | | Collection | getGroups()
Access the groups defined for this message. | | String | getId()
Access the unique (within the channel) message id. | | Element | toXml(Document doc, Stack stack)
Serialize the resource into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "resource" element. |
| getAccess | | MessageAccess getAccess()(Code) | | Access the access mode for the message - how we compute who has access to the message.
The MessageAccess access mode for the message. |
| getDate | | Time getDate()(Code) | | Access the date/time the message was sent to the channel.
The date/time the message was sent to the channel. |
| getDraft | | boolean getDraft()(Code) | | Access the draft status of the message.
True if the message is a draft, false if not. |
| getFrom | | User getFrom()(Code) | | Access the User who sent the message to the channel.
The User who sent the message to the channel. |
| getGroupObjects | | Collection getGroupObjects()(Code) | | Access the groups, as Group objects, defined for this message.
A Collection (Group) of group objects defined for this message; empty if none are defined. |
| getGroups | | Collection getGroups()(Code) | | Access the groups defined for this message.
A Collection (String) of group refs (authorization group ids) defined for this message; empty if none are defined. |
| getId | | String getId()(Code) | | Access the unique (within the channel) message id.
The unique (within the channel) message id. |
| toXml | | Element toXml(Document doc, Stack stack)(Code) | | Serialize the resource into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "resource" element. The newly added element. |
|
|