com.dukascopy.api

Interface INewsMessage

All Superinterfaces:

IMessage

All Known Subinterfaces:

ICalendarMessage

public interface INewsMessage
extends IMessage

News message definition - received as result of subscription using INewsFilter

Author:

Denis Larka

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	INewsMessage.Action Actions

Nested classes/interfaces inherited from interface com.dukascopy.api.IMessage

IMessage.Reason, IMessage.Type

Method Summary

Methods

Modifier and Type	Method and Description
INewsMessage.Action	getAction() Returns action
String	getCopyright() Returns copyright
long	getCreationTime() Returns time when message was published
Set<String>	getCurrencies() Returns ISO 4217 currency codes
Set<String>	getGeoRegions() Returns geo regions
String	getHeader() Returns header
String	getId() Returns ID
Set<String>	getMarketSectors() Returns market sectors
long	getPublishDate() Returns publish date
Set<String>	getStockIndicies() Returns stock indices
boolean	isEndOfStory()
boolean	isHot()

Methods inherited from interface com.dukascopy.api.IMessage

getContent, getOrder, getReasons, getType

Method Detail

getAction

INewsMessage.Action getAction()

Returns action

Returns:

action as INewsMessage.Action

getCopyright

String getCopyright()

Returns copyright

Returns:

copyright as String

getHeader

String getHeader()

Returns header

Returns:

header as String

getId

String getId()

Returns ID

Returns:

ID as String

getPublishDate

long getPublishDate()

Returns publish date

Returns:

publish date as long

isEndOfStory

boolean isEndOfStory()

Returns:

true if this news is end of story

isHot

boolean isHot()

Returns:

true if this news is "hot"

getCurrencies

Set<String> getCurrencies()

Returns ISO 4217 currency codes

Returns:

currencies as Set of String - can be interpreted using INewsFilter.Currency's valueOf() method (only limited amount of currencies) or JFCurrency.getInstance(String) (preferred)

getGeoRegions

Set<String> getGeoRegions()

Returns geo regions

Returns:

geo regions as Set of String - can be interpreted using INewsFilter.Country's valueOf() method

getMarketSectors

Set<String> getMarketSectors()

Returns market sectors

Returns:

market sectors as Set of String - can be interpreted using INewsFilter.MarketSector's valueOf() method

getStockIndicies

Set<String> getStockIndicies()

Returns stock indices

Returns:

stock indices as Set of String - can be interpreted using INewsFilter.StockIndex's valueOf() method

getCreationTime

long getCreationTime()

Returns time when message was published

Specified by:

getCreationTime in interface IMessage

Returns:

time when message was created