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

Nested Class Summary
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 indicies 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 indicies
static class INewsFilter.Type
          News types
 
Method Summary
 java.util.Set<INewsFilter.Country> getCountries()
          Returns subscription's countries
 java.util.Set<INewsFilter.Currency> getCurrencies()
          Returns subscription's currencies
 java.util.Set<INewsFilter.EventCategory> getEventCategories()
          Returns subscription's event categories
 java.util.Date getFrom()
          Returns subscription's period's start
 java.util.Set<java.lang.String> getKeywords()
          Returns subscription's keywords
 java.util.Set<INewsFilter.MarketSector> getMarketSectors()
          Returns subscription's market sectors
 INewsFilter.NewsSource getNewsSource()
          Returns subscription's news source
 java.util.Set<INewsFilter.StockIndex> getStockIndicies()
          Returns subscription's stock indicies
 INewsFilter.Type getType()
          Returns subscription's news type
 java.util.Date getTo()
          Returns subscription's period's end
 boolean isOnlyHot()
          Returns subscription to "hot" news state
 

Method Detail

getNewsSource

INewsFilter.NewsSource getNewsSource()
Returns subscription's 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

java.util.Set<INewsFilter.Country> getCountries()
Returns subscription's countries

Returns:
countries as Set of INewsFilter.Country

getStockIndicies

java.util.Set<INewsFilter.StockIndex> getStockIndicies()
Returns subscription's stock indicies

Returns:
stock indicies as Set of INewsFilter.StockIndex

getMarketSectors

java.util.Set<INewsFilter.MarketSector> getMarketSectors()
Returns subscription's market sectors

Returns:
market sectors as Set of INewsFilter.MarketSector

getCurrencies

java.util.Set<INewsFilter.Currency> getCurrencies()
Returns subscription's currencies

Returns:
currencies as Set of INewsFilter.Currency

getEventCategories

java.util.Set<INewsFilter.EventCategory> getEventCategories()
Returns subscription's event categories

Returns:
event categories as Set of INewsFilter.EventCategory

getFrom

java.util.Date getFrom()
Returns subscription's period's start

Returns:
period's start as Date

getTo

java.util.Date getTo()
Returns subscription's period's end

Returns:
period's end as Date

getKeywords

java.util.Set<java.lang.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