Package com.dukascopy.api

Interface Summary

Interface	Description
ChartObjectListener	All notifications are called in strategy thread
ConfigurableChangeListener
DataLoadingListener	Listener to receive ticks and candles
IAccount	Methods of this interface allows to retrieve account information such as current equity
IBar	Represents a bar (candle).
ICalendarMessage	Calendar message definition - recieved as result of subscription using INewsFilter with source : INewsFilter.NewsSource.DJ_LIVE_CALENDAR
ICalendarMessage.Detail	Calendar message's detail
IChart	Allows to draw graphical objects on the chart
IChartObject	Represents graphical object on the chart
IChartPanel	Chart panel container for objects of corresponding type.
IClientChartController	Allows control over the chart objects and mouse listeners NOTE: Used only by Standalone JForex API.
IClientChartPresentationManager	Manages Chart presentation modes (Period, DataType, etc.). NOTE: Used only by Standalone JForex API.
IClientGUI	Provides access to specific IChart and its IClientChartPresentationManager. NOTE: Used only by Standalone JForex API. TODO: to be vetted.
IClientGUIListener	Interface for listeners which are "interested" in open / close charts from strategy NOTE: Used only by JForex SDK.
IClientInfo	Contains the account's clients information.
ICloseOrder	Contains partial order data when order was partially or fully closed by server, respectively. Order's lifecycle contains from 0 to many elements of this data.
IConnectionStatusMessage	Notification message about connection status changes
IConsole	Allows to print messages to Messages table
IContext	Gives access to the various parts of the system
ICurrency
IDailyHighLowListener	Listens to the daily maximum and minimum prices for corresponding instrument
IDataService	Provide with system state: The information about high/low prices for corresponding instruments and periods.
IDownloadableStrategies
IDownloadableStrategy
IEngine	Interface to the main engine, that allows orders submission, merging etc
IFillOrder	Contains partial order data when order was partially or fully filled by server, respectively. Order's lifecycle contains from 0 to many elements of this data.
IFXSentimentIndex	Forex Sentiment Index. Shows the percentage of longs in the overall amount of open trades in the most popular currencies and currency pairs consolidated by liquidity consumers. The sentiment ratio of Liquidity providers is opposite to Liquidity consumers (opposite to IFXSentimentIndex.getIndexValue(). The index reflects the distribution of the current market conditions and is updated every 30 minutes.
IFXSentimentIndexBar	Forex Sentiment Index. Aggregation over Forex Sentiment Indices' long values which shows the percentage of longs in the overall amount of open trades in the most popular currencies and currency pairs consolidated by liquidity consumers. The index reflects the distribution of the current market conditions and is updated every 30 minutes.
IFXTimedSentimentIndex
IHighLowListener	Listens to the maximum and minimum prices for corresponding instrument
IHistory	The IHistory interface represents API for historical data access.
IIndicatorPanel
IIndicators	Contains a set of functions to calculate indicator data
IInstrumentStatusMessage	Notification message about instrument's tradability changes
IJFRunnable<T extends IContext>
ILoadingReportPositionListener	Listens to the new loaded IReportPosition
IMessage	Represents message sent from server to client application
INewsFilter	News filter definition - used for INewsMessage subscription. Default implementations : NewsFilter & CalendarFilter
INewsMessage	News message definition - received as result of subscription using INewsFilter
IOrder	Contains order data and allows order manipulation
IPartialOrder	Contains partial order data (either fill or close) when order was partially or fully filled or closed by server, respectively. Order's lifecycle contains from 0 to many elements of this data.
IReportPosition	Provides information about report position
IReportService	Provide access to consolidated trading activity reports: The position report consolidates the trading activity reporting by grouping open and close orders ...
ISignal	Signals, generated by strategy
ISignalsProcessor
IStopLossLevelChangedMessage	Represents client's stop loss level changing message
IStrategies	Deprecated please use IClient.startStrategy instead.
IStrategy	Interface that all strategies should implement
IStrategyBroadcastMessage	Represents message broadcasted by strategy
IStrategyListener
ITick	Tick data
ITimedData
ITimeDomain
IUserInterface	Provides access to various user interface parts
IWithdrawalMessage	Represents client's withdrawal action
IWLabelData	Contains the information about White Label service
JFUtils
LineStyle	Set of Line Style Patterns
LoadingDataListener	Listener to receive ticks and candles
LoadingOrdersListener
LoadingProgressListener	Listener to follow and control (cancel) loading progress
NewsFilter.ITimeFrame

Class Summary

Class	Description
CalendarFilter	Default Serializable implementation of INewsFilter for INewsFilter.NewsSource.DJ_LIVE_CALENDAR
ChartObjectAdapter	Implementation of listener with empty methods
ChartObjectEvent	Event used to pass parameters of chart object change
ConsoleAdapter
JFCurrency
LineBreakLookback	This class is used for Line Break data look-back identification.
Money	Straightforward money bean (double value along with ICurrency). Intended to be used in expressing monetary amounts and prices.
NewsFilter	Default Serializable implementation of INewsFilter
Period	Represents periods of bars.
PriceRange	The class is used for Range Bar and Point&Figures price interval in pips identification
ReversalAmount	The class indicates the amount of price movement required to shift a chart to the right.
TickBarSize	The class indicates the number of ticks to be included to one Tick Bar

Enum Summary

Enum	Description
CalendarFilter.TimeFrame	Utility enum for end date calculations
ChartObjectEvent.AttrType	Type of the attribute change event
DataType	The enumeration describes several data types used in JForex
DataType.DataPresentationType
Filter	Different methods of flats filtering
IAccount.AccountState	Account state: OK, MARGIN_CLOSING, MARGIN_CALL, OK_NO_MARGIN_CALL, DISABLED, BLOCKED.
IChart.Type	Type of the graphical object
IChartObject.ATTR_BOOLEAN	Deprecated
IChartObject.ATTR_COLOR	Deprecated
IChartObject.ATTR_DOUBLE	Deprecated
IChartObject.ATTR_INT	Deprecated
IChartObject.ATTR_LONG	Deprecated
IChartObject.ATTR_TEXT	Deprecated
IDownloadableStrategy.ComponentType
IEngine.OrderCommand	Specifies type of the order
IEngine.RunMode	Stands for strategy run mode - if it is ran locally or on remote server
IEngine.StrategyMode	Specifies strategy running mode.
IEngine.Type	Type of the engine
IIndicators.AppliedPrice	Used to specify which price to use for indicator calculation
IIndicators.MaType	Types of Moving Average
IMessage.Reason	Reason of message.
IMessage.Type	Type of the message
INewsFilter.Country	Countries
INewsFilter.Currency	Currencies
INewsFilter.EventCategory	Event Category contains an ID of the event category so that historical events can be linked
INewsFilter.IndexRegion	Stock indices regions - used for INewsFilter.StockIndex grouping
INewsFilter.MarketSector	Market sectors
INewsFilter.NewsSource	News sources
INewsFilter.Region	Geo regions - used for INewsFilter.Country grouping
INewsFilter.StockIndex	Stock indices
INewsFilter.Type	News types
INewsMessage.Action	Actions
Instrument	Defines all currency pairs traded by Dukascopy
IOrder.State	Indicates state of the order
IReportPosition.PositionType	Indicates type of Position
ISignal.Type
JFException.Error	Used to easily create exceptions with appropriate message
JFTimeZone	This class represents time zone.
NewsFilter.TimeFrame	Utility enum for end date calculations
OfferSide	Defines offer side
Unit	Defines time units

Exception Summary

Exception	Description
JFException	Used to indicate errors when calling API functions

Annotation Types Summary

Annotation Type	Description
Configurable	Fields marked with this annotation will be shown in dialog before strategy start.
CustomIndicators	Pass indicator paths separated by File.pathSeparator for custom indicators that need to be packaged into the compiled strategy .jfx file.
INewsFilter.AcceptByMarketNewsFilter	Marker annotation for news filter elements accepted by Market News filter.
Library	Strategy launcher looks into the source of the strategy class for this annotations and includes libraries specified in this annotation into the classpath
RequiresFullAccess	When strategy loader sees this annotation for strategy class it asks user if he wants to allow the strategy full access.