Package com.caplin.datasource.interfaces

Interface DSStory

All Superinterfaces:

DSData, DSPacket, DSSerializable, 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 Summary

Fields

Modifier and Type	Field	Description
static final int	APPEND	This story text should be appended to any other story of the same name.
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.

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

Modifier and Type	Method	Description
void	setStoryText(String storyText)	Set the text for this story.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

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 Details

setStoryText

void setStoryText(String storyText)

Set the text for this story.

Parameters:

storyText - the String holding the text content of this story