Package com.caplin.datasource.interfaces

Interface DSNews

All Superinterfaces:
DSData, DSPacket, DSSerializable, Iterable<DSField>
public interface DSNews extends DSData

Extends DSData to provide helper methods for sending News.

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 Details

    • F_DELETE_HEADLINE

      static final int F_DELETE_HEADLINE
      Delete the headline identified with the story code in this update.
      See Also:

    • F_CHANGE_HEADLINE

      static final int F_CHANGE_HEADLINE
      Change the headline identified with the story code in this update.
      See Also:

    • NEWS_HEADLINE_FIELDNUM

      static final int NEWS_HEADLINE_FIELDNUM
      The field used to hold the news headline string
      See Also:

    • NEWS_STORYCODE_FIELDNUM

      static final int NEWS_STORYCODE_FIELDNUM
      The field used to hold the news storycode identified
      See Also:

    • NEWS_DATETIME_FIELDNUM

      static final int NEWS_DATETIME_FIELDNUM
      The field used to hold the news date/time string
      See Also:

    • NEWS_AUTHSTRING_FIELDNUM

      static final int NEWS_AUTHSTRING_FIELDNUM
      The field used to hold the news authentication string.
      See Also:

    • NEWS_PRODUCT_CODE_FIELDNUM

      static final int NEWS_PRODUCT_CODE_FIELDNUM
      The field used to hold the list of product codes associated with this news story
      See Also:

    • NEWS_TOPIC_CODE_FIELDNUM

      static final int NEWS_TOPIC_CODE_FIELDNUM
      The field used to hold the list of topic codes associated with this news story
      See Also:

    • NEWS_COMPANY_CODE_FIELDNUM

      static final int NEWS_COMPANY_CODE_FIELDNUM
      The field used to hold the list of company codes associated with this news story
      See Also:

    • NEWS_CUSTOM_CODE_BASE_FIELDNUM

      static final int NEWS_CUSTOM_CODE_BASE_FIELDNUM
      The base field used to hold any cust
      See Also:

    • NEWS_CUSTOM_CODE_MAX

      static final int NEWS_CUSTOM_CODE_MAX

      The maximum number of custom user-defined news code types allowed.

      The codes will use field numbers ranging from NEWS_CUSTOM_CODE_BASE_FIELDNUM to NEWS_CUSTOM_CODE_BASE_FIELDNUM + NEWS_CUSTOM_CODE_MAX - 1.

      See Also:

    • NEWS_SIZE_FIELDNUM

      static final int NEWS_SIZE_FIELDNUM
      Use to indicate to the clients the size of the subsequent headline response. Typically used in the initial packet as a response to a client-driven news search request. This can be used for batching of results, useful when a client search has generated a large number of matches.
      See Also:

    • NEWS_REASON_FIELDNUM

      static final int NEWS_REASON_FIELDNUM
      Typically used to indicate a reason for a zero-headline response to a client-driven news search. For example: news service unavailable, no matches found etc.
      See Also:

    • NEWS_REQ_DATE_TO

      static final int NEWS_REQ_DATE_TO
      Field number used for client-driven news search requests - if present, will contain the most recent date bound for the search.
      See Also:

    • NEWS_REQ_DATE_FROM

      static final int NEWS_REQ_DATE_FROM
      Field number used for client-driven news search requests - if present, will contain the oldest date bound for the search.
      See Also:

    • NEWS_REQ_FLAGS

      static final int NEWS_REQ_FLAGS
      Field number used for client-driven news search requests - if present, will contain any flags for the search, for example to represent full-story search / headline search etc.
      See Also:

    • NEWS_REQ_STORYCODE

      static final int NEWS_REQ_STORYCODE
      Field number used for client-driven news search requests - if present, will contain the last storycode received by the client - useful for more granular batching than simple date-bounded requests.
      See Also:

  • Method Details

    • setHeadline

      void setHeadline(String headline)

      Set the news headline text.

      Parameters:
      headline - the headline text.

    • setStoryCode

      void setStoryCode(String story)

      Set the headline's associated story code.

      Parameters:
      story - the story code.

    • setDisplayTimeStamp

      void setDisplayTimeStamp(String date)

      Sets the date/time of this news headline.

      Parameters:
      date - the date and time of the headline.

    • setAuthString

      void setAuthString(String auth)

      Sets an authorisation string for this headline. This can be used for a check by an authentication module to see if a user is entitled to view the headline.

      Parameters:
      auth - the authorisation string - there is a maximum of 32 characters supported by the Liberator for this string (any additional characters will be truncated).

    • addProductCode

      void addProductCode(String code)

      Adds a product code.

      Parameters:
      code - the product code to be added.

    • addProductCodes

      void addProductCodes(String[] codes)

      Adds an array of product code.

      Parameters:
      codes - the product codes to be added.

    • addTopicCode

      void addTopicCode(String code)

      Adds a topic code.

      Parameters:
      code - the topic code to be added.

    • addTopicCodes

      void addTopicCodes(String[] codes)

      Adds an array of topic codes.

      Parameters:
      codes - the topic codes to be added.

    • addCompanyCode

      void addCompanyCode(String code)

      Adds a company code.

      Parameters:
      code - the company code to be added.

    • addCompanyCodes

      void addCompanyCodes(String[] codes)

      Adds an array of company codes.

      Parameters:
      codes - the company codes to be added.

    • addCustomCode

      void addCustomCode(int codeNum, String code)

      Adds a custom user-define code.

      Parameters:
      codeNum - an identifier for this type of code.
      code - the code to be added.
      Throws:
      IndexOutOfBoundsException - if the codeNum is < 1 or >= NEWS_CUSTOM_CODE_MAX

    • addCustomCodes

      void addCustomCodes(int codeNum, String[] codes)

      Adds an array of custom user-define codes.

      Parameters:
      codeNum - an identifier for this type of code.
      codes - the codes to be added.
      Throws:
      IndexOutOfBoundsException - if the codeNum is < 1 or >= NEWS_CUSTOM_CODE_MAX