Docs For Class Message

Description

Messages contain read-only attributes. Note that the message attributes don't contain delivery time.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Method Summary

object mixed getContent ()

object Type getDeliveryType ()

int getMessageTimestamp ()

object Type getMessageType ()

object Id getSender ()

string getTopic ()

Methods

getContent (line 40)

Get the content of this Message.

return: (original type: java.io.Serializable)
access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object mixed getContent ()

getDeliveryType (line 88)

Get the DeliveryType of this Message.

access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getDeliveryType ()

getMessageTimestamp (line 112)

Get the time the Message was sent.

access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

int getMessageTimestamp ()

getMessageType (line 64)

Get the MessageType of this Message.

access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getMessageType ()

getSender (line 163)

Get the agentId that sent the Message.

access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getSender ()

getTopic (line 139)

Get the Topic of the Message. Note that the Topic is not necessarily the subject of the Message. The subject can be embedded in the Content.

The intent is that the Topic is the same Topic used in CourseManagement to refer to an area of interest.

access: public
throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getTopic ()