com.dukascopy.api

Interface INewsFilter

All Known Implementing Classes:

CalendarFilter, NewsFilter

public interface INewsFilter

News filter definition - used for INewsMessage subscription.
Default implementations : NewsFilter & CalendarFilter

Author:

viktor.sjubajev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INewsFilter.AcceptByMarketNewsFilter Marker annotation for news filter elements accepted by Market News filter.
static class	INewsFilter.Country Countries
static class	INewsFilter.Currency Currencies
static class	INewsFilter.EventCategory Event Category contains an ID of the event category so that historical events can be linked
static class	INewsFilter.IndexRegion Stock indices regions - used for INewsFilter.StockIndex grouping
static class	INewsFilter.MarketSector Market sectors
static class	INewsFilter.NewsSource News sources
static class	INewsFilter.Region Geo regions - used for INewsFilter.Country grouping
static class	INewsFilter.StockIndex Stock indices
static class	INewsFilter.Type News types

Method Summary

Methods

Modifier and Type	Method and Description
Set<INewsFilter.Country>	getCountries() Returns subscription's countries
Set<INewsFilter.Currency>	getCurrencies() Returns subscription's currencies
Set<INewsFilter.EventCategory>	getEventCategories() Returns subscription's event categories
Date	getFrom() Returns subscription's period's start
Set<String>	getKeywords() Returns subscription's keywords
Set<INewsFilter.MarketSector>	getMarketSectors() Returns subscription's market sectors
INewsFilter.NewsSource	getNewsSource() Deprecated. use getNewsSources()}
Set<INewsFilter.NewsSource>	getNewsSources() Returns subscription's news sources
Set<INewsFilter.StockIndex>	getStockIndicies() Returns subscription's stock indicies
Date	getTo() Returns subscription's period's end
INewsFilter.Type	getType() Returns subscription's news type
boolean	isOnlyHot() Returns subscription to "hot" news state

Method Detail

getNewsSources

Set<INewsFilter.NewsSource> getNewsSources()

Returns subscription's news sources

Returns:

news sources as INewsFilter.NewsSource

getNewsSource

@Deprecated
INewsFilter.NewsSource getNewsSource()

Deprecated. use getNewsSources()}

Returns subscription's the first news source

Returns:

news source as INewsFilter.NewsSource

isOnlyHot

boolean isOnlyHot()

Returns subscription to "hot" news state

Returns:

true if subscription is only for "hot" news

getCountries

Set<INewsFilter.Country> getCountries()

Returns subscription's countries

Returns:

countries as Set of INewsFilter.Country

getStockIndicies

Set<INewsFilter.StockIndex> getStockIndicies()

Returns subscription's stock indicies

Returns:

stock indices as Set of INewsFilter.StockIndex

getMarketSectors

Set<INewsFilter.MarketSector> getMarketSectors()

Returns subscription's market sectors

Returns:

market sectors as Set of INewsFilter.MarketSector

getCurrencies

Set<INewsFilter.Currency> getCurrencies()

Returns subscription's currencies

Returns:

currencies as Set of INewsFilter.Currency

getEventCategories

Set<INewsFilter.EventCategory> getEventCategories()

Returns subscription's event categories

Returns:

event categories as Set of INewsFilter.EventCategory

getFrom

Date getFrom()

Returns subscription's period's start

Returns:

period's start as Date

getTo

Date getTo()

Returns subscription's period's end

Returns:

period's end as Date

getKeywords

Set<String> getKeywords()

Returns subscription's keywords

Returns:

keywords as Set of String

getType

INewsFilter.Type getType()

Returns subscription's news type

Returns:

news type as INewsFilter.Type