Interface DSStory

  • All Superinterfaces:
    DSData, DSPacket, DSSerializable, java.lang.Iterable<DSField>

    public interface DSStory
    extends DSData

    Extends DSData to provide helper methods for sending News Stories.

    An instance of DSNews should define the headline text that provides a brief description of a news article. A story code should be defined if this DSNews has a corresponding story for the headline, and should uniquely identify that story. A date/time should be defined to represent the date and time that the headline was created. Any number and combinations of product, topic, company and user codes can be added to provide meta data about the headline, such as which products, topics or companies it is related to. The auth string is used to allow a Liberator authentication module check access to this headline based on the provided string.
    • Field Detail

      • CLEAR

        static final int CLEAR
        This story text should clear and replace any other story of the same name, or create a new story if one doesn't already exist.
        See Also:
        Constant Field Values
      • APPEND

        static final int APPEND
        This story text should be appended to any other story of the same name.
        See Also:
        Constant Field Values
    • Method Detail

      • setStoryText

        void setStoryText​(java.lang.String storyText)
        Set the text for this story.
        storyText - the String holding the text content of this story