Interface DSNews
-
- All Superinterfaces:
DSData
,DSPacket
,DSSerializable
,java.lang.Iterable<DSField>
public interface DSNews extends DSData
Extends
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.DSData
to provide helper methods for sending News.
-
-
Field Summary
Fields Modifier and Type Field Description static int
F_CHANGE_HEADLINE
Change the headline identified with the story code in this update.static int
F_DELETE_HEADLINE
Delete the headline identified with the story code in this update.static int
NEWS_AUTHSTRING_FIELDNUM
The field used to hold the news authentication string.static int
NEWS_COMPANY_CODE_FIELDNUM
The field used to hold the list of company codes associated with this news storystatic int
NEWS_CUSTOM_CODE_BASE_FIELDNUM
The base field used to hold any custstatic int
NEWS_CUSTOM_CODE_MAX
The maximum number of custom user-defined news code types allowed.static int
NEWS_DATETIME_FIELDNUM
The field used to hold the news date/time stringstatic int
NEWS_HEADLINE_FIELDNUM
The field used to hold the news headline stringstatic int
NEWS_PRODUCT_CODE_FIELDNUM
The field used to hold the list of product codes associated with this news storystatic int
NEWS_REASON_FIELDNUM
Typically used to indicate a reason for a zero-headline response to a client-driven news search.static 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.static 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.static 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.static int
NEWS_REQ_SEARCH
Field number used for client-driven news search requests - will contain the search string.static 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.static int
NEWS_SIZE_FIELDNUM
Use to indicate to the clients the size of the subsequent headline response.static int
NEWS_STORYCODE_FIELDNUM
The field used to hold the news storycode identifiedstatic int
NEWS_TOPIC_CODE_FIELDNUM
The field used to hold the list of topic codes associated with this news story-
Fields inherited from interface com.caplin.datasource.interfaces.DSData
CONTAINER_TYPE, F_AUTH_UPDATE, F_AUTHGLOBAL, F_CHANGEDFIELDS, F_CLEAR_PERMISSIONS, F_CLEAR_TYPE2, F_CLEAR_TYPE3, F_CREATEOBJECT, F_CREATEPARENT, F_DELETE_PERMISSION, F_FILTER_TYPE2, F_FILTER_TYPE3, F_IMAGE, F_NONACTIVE, GENERIC_TYPE, NEWS_TYPE, PAGE_TYPE, PERMISSION_TYPE, RECORD_TYPE, STORY_TYPE, TYPE2_RECORD_TYPE, TYPE3_RECORD_TYPE, UNKNOWN_TYPE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCompanyCode(java.lang.String code)
Adds a company code.void
addCompanyCodes(java.lang.String[] codes)
Adds an array of company codes.void
addCustomCode(int codeNum, java.lang.String code)
Adds a custom user-define code.void
addCustomCodes(int codeNum, java.lang.String[] codes)
Adds an array of custom user-define codes.void
addProductCode(java.lang.String code)
Adds a product code.void
addProductCodes(java.lang.String[] codes)
Adds an array of product code.void
addTopicCode(java.lang.String code)
Adds a topic code.void
addTopicCodes(java.lang.String[] codes)
Adds an array of topic codes.void
setAuthString(java.lang.String auth)
Sets an authorisation string for this headline.void
setDisplayTimeStamp(java.lang.String date)
Sets the date/time of this news headline.void
setHeadline(java.lang.String headline)
Set the news headline text.void
setStoryCode(java.lang.String story)
Set the headline's associated story code.-
Methods inherited from interface com.caplin.datasource.interfaces.DSData
addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addBinaryData, addData, addData, addData, addData, addData, addData, addData, addData, clearFields, count, elements, getFieldByFieldNumber, getFieldByFieldNumber, getFlags, getKeys, getSubject, getType, getValues, iterator, removeField, setFlags, setSubject, setType, updateData, updateData
-
Methods inherited from interface com.caplin.datasource.interfaces.DSPacket
send, sendDirect, sendToPeer
-
Methods inherited from interface com.caplin.datasource.interfaces.DSSerializable
toBytes
-
-
-
-
Field Detail
-
F_DELETE_HEADLINE
static final int F_DELETE_HEADLINE
Delete the headline identified with the story code in this update.- See Also:
- Constant Field Values
-
F_CHANGE_HEADLINE
static final int F_CHANGE_HEADLINE
Change the headline identified with the story code in this update.- See Also:
- Constant Field Values
-
NEWS_HEADLINE_FIELDNUM
static final int NEWS_HEADLINE_FIELDNUM
The field used to hold the news headline string- See Also:
- Constant Field Values
-
NEWS_STORYCODE_FIELDNUM
static final int NEWS_STORYCODE_FIELDNUM
The field used to hold the news storycode identified- See Also:
- Constant Field Values
-
NEWS_DATETIME_FIELDNUM
static final int NEWS_DATETIME_FIELDNUM
The field used to hold the news date/time string- See Also:
- Constant Field Values
-
NEWS_AUTHSTRING_FIELDNUM
static final int NEWS_AUTHSTRING_FIELDNUM
The field used to hold the news authentication string.- See Also:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
NEWS_CUSTOM_CODE_BASE_FIELDNUM
static final int NEWS_CUSTOM_CODE_BASE_FIELDNUM
The base field used to hold any cust- See Also:
- Constant Field Values
-
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
toNEWS_CUSTOM_CODE_BASE_FIELDNUM
+NEWS_CUSTOM_CODE_MAX
- 1.
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
NEWS_REQ_SEARCH
static final int NEWS_REQ_SEARCH
Field number used for client-driven news search requests - will contain the search string.- See Also:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
-
Method Detail
-
setHeadline
void setHeadline(java.lang.String headline)
Set the news headline text.
- Parameters:
headline
- the headline text.
-
setStoryCode
void setStoryCode(java.lang.String story)
Set the headline's associated story code.
- Parameters:
story
- the story code.
-
setDisplayTimeStamp
void setDisplayTimeStamp(java.lang.String date)
Sets the date/time of this news headline.
- Parameters:
date
- the date and time of the headline.
-
setAuthString
void setAuthString(java.lang.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(java.lang.String code)
Adds a product code.
- Parameters:
code
- the product code to be added.
-
addProductCodes
void addProductCodes(java.lang.String[] codes)
Adds an array of product code.
- Parameters:
codes
- the product codes to be added.
-
addTopicCode
void addTopicCode(java.lang.String code)
Adds a topic code.
- Parameters:
code
- the topic code to be added.
-
addTopicCodes
void addTopicCodes(java.lang.String[] codes)
Adds an array of topic codes.
- Parameters:
codes
- the topic codes to be added.
-
addCompanyCode
void addCompanyCode(java.lang.String code)
Adds a company code.
- Parameters:
code
- the company code to be added.
-
addCompanyCodes
void addCompanyCodes(java.lang.String[] codes)
Adds an array of company codes.
- Parameters:
codes
- the company codes to be added.
-
addCustomCode
void addCustomCode(int codeNum, java.lang.String code)
Adds a custom user-define code.
- Parameters:
codeNum
- an identifier for this type of code.code
- the code to be added.- Throws:
java.lang.IndexOutOfBoundsException
- if the codeNum is < 1 or >=NEWS_CUSTOM_CODE_MAX
-
addCustomCodes
void addCustomCodes(int codeNum, java.lang.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:
java.lang.IndexOutOfBoundsException
- if the codeNum is < 1 or >=NEWS_CUSTOM_CODE_MAX
-
-