Package com.caplin.streamlink

Interface NewsEvent

All Superinterfaces:

DataEvent

public interface NewsEvent
extends DataEvent

Provides information about a news headline update.

Method Summary

Modifier and Type	Method	Description
String	getDateTime()	Returns the date/time associated with this headline update.
Map<String,String>	getFields()	Returns all field/value pairs that were updated in this update.
String	getHeadline()	Returns the headline for this update.
String	getStoryCode()	Returns the story code associated with this update.

Methods inherited from interface com.caplin.streamlink.DataEvent

getSubject, isImage

Method Details

getHeadline

String getHeadline()

Returns the headline for this update.

Returns:

The headline.

getStoryCode

String getStoryCode()

Returns the story code associated with this update.

The value of the code can be used to construct a news story subject to obtain the full text of the news item.

Returns:

The story code.

getDateTime

String getDateTime()

Returns the date/time associated with this headline update.

The format of the date/time string is dependent on the implementation of the Integration Adapter that supplied the new headline. Generally it will be in a displayable format.

Returns:

The date/time stamp.

getFields

Map<String,String> getFields()

Returns all field/value pairs that were updated in this update.

This data structure allows access to any additional information associated with the news headline update which aren't available directly.

Returns:

A collection of field/value pairs.