Interface Message

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      MessageType getMessageType()
      Gets the type for this message.
      java.lang.String getSubject()
      Gets the subject of this message.
      boolean isImage()
      Gets a boolean value indicating whether this Message represents an image or an update.
      void setImage​(boolean image)
      Sets a boolean value indicating whether this Message represents an image of the data or an update to it.
    • Method Detail

      • isImage

        boolean isImage()
        Gets a boolean value indicating whether this Message represents an image or an update. By default, this method returns false indicating that the Message is an update and not an image. To change a message to be an image, call setImage(boolean) passing in the value true.
        Returns:
        true if this message is an image of the object, false if it is an update to the existing state of the object.
      • setImage

        void setImage​(boolean image)
        Sets a boolean value indicating whether this Message represents an image of the data or an update to it. By default, a newly created Message is deemed to be an update and not an image.
        Parameters:
        image - When set to true, the receiver will clear all previous data for that subject before adding the sent data. When set to false, the receiver adds the sent data to previous data sent to that subject.
      • getSubject

        java.lang.String getSubject()
        Gets the subject of this message.
        Returns:
        The subject.
      • getMessageType

        MessageType getMessageType()
        Gets the type for this message.
        Returns:
        The MessageType for this message