online.mtapi.mt4

Class OrderClient

java.lang.Object

online.mtapi.mt4.OrderClient

public class OrderClient
extends java.lang.Object

Trading client.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	IsDemoAccount
Logger	Log
online.mtapi.mt4.MT4Symbol	MT4Symbol
Event<OrderProgressEventHandler>	OnOrderProgress Open/close progress of the order before ticket number assign.
QuoteClient	QuoteClient
boolean	QuoteClientInitSymbols
int	TradeTimeout How long to wait for trade execution, if TradeTimeoutException no reply from server.
int	User Account number.

Constructor Summary

Constructors

Constructor and Description
OrderClient() Initialize order client.
OrderClient(QuoteClient qc) Main constructor.

Method Summary

Modifier and Type	Method and Description
void	onProgress(byte[] buf, ProgressType type, int RequestID, java.lang.Exception exception)
Order	OrderClose(java.lang.String symbol, int ticket, double volume, double price, int slippage) Close opened order.
int	OrderCloseAsync(java.lang.String symbol, int ticket, double volume, double price, int slippage) Close opened order without awiting reply from server.
void	OrderCloseBy(java.lang.String symbol, int ticket1, int ticket2) Close of pair of opposite open orders.
int	OrderCloseByAsync(java.lang.String symbol, int ticket1, int ticket2) Close of pair of opposite open orders without awiting reply from server.
void	OrderDelete(int ticket, Op type, java.lang.String symbol, double volume, double price) Delete pending order.
int	OrderDeleteAsync(int ticket, Op type, java.lang.String symbol, double volume, double price) Delete pending order without awiting reply from server.
Order	OrderModify(Op type, int ticket, double price, double stoploss, double takeprofit, java.time.LocalDateTime expiration) Modification of previously opened position or pending orders.
int	OrderModifyAsync(Op type, int ticket, double price, double stoploss, double takeprofit, java.time.LocalDateTime expiration) Modification of characteristics for the previously opened position or pending orders without awiting reply from server.
void	OrderMultipleCloseBy(java.lang.String symbol) Close of multiple open orders.
int	OrderMultipleCloseByAsync(java.lang.String symbol) Close of multiple open orders without awiting reply from server.
Order	OrderSend(java.lang.String symbol, Op operation, double volume, double price, int slippage, double stoploss, double takeprofit) The main function used to open a position or place a pending order.
Order	OrderSend(java.lang.String symbol, Op operation, double volume, double price, int slippage, double stoploss, double takeprofit, java.lang.String comment, int magic, java.time.LocalDateTime expiration) The main function used to open a position or place a pending order.
int	OrderSendAsync(java.lang.String symbol, Op operation, double volume, double price, int slippage, double stoploss, double takeprofit) Send order without awiting reply from server.
int	OrderSendAsync(java.lang.String symbol, Op operation, double volume, double price, int slippage, double stoploss, double takeprofit, java.lang.String comment, int magic, java.time.LocalDateTime expiration) Send order without awiting reply from server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OnOrderProgress

public Event<OrderProgressEventHandler> OnOrderProgress

Open/close progress of the order before ticket number assign.

TradeTimeout

public int TradeTimeout

How long to wait for trade execution, if TradeTimeoutException no reply from server.

Log

public Logger Log

User

public int User

Account number.

MT4Symbol

public online.mtapi.mt4.MT4Symbol MT4Symbol

QuoteClientInitSymbols

public boolean QuoteClientInitSymbols

IsDemoAccount

public boolean IsDemoAccount

QuoteClient

public QuoteClient QuoteClient

Constructor Detail

OrderClient

public OrderClient()

Initialize order client. For using with COM. Call Init() after constructor.

OrderClient

public OrderClient(QuoteClient qc)

Main constructor.

Parameters:

qc - Quote client.

Method Detail

OrderModify

public Order OrderModify(Op type,
                         int ticket,
                         double price,
                         double stoploss,
                         double takeprofit,
                         java.time.LocalDateTime expiration)
                  throws TimeoutException

Modification of previously opened position or pending orders.

Parameters:

type - Operation type.

ticket - Unique number of the order ticket.

price - Price value.

stoploss - Stop loss level.

takeprofit - Take profit level.

expiration - Expiration time.

Returns:

Modified order.

Throws:

TradeContextBusyException - All trade connections are busy.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderModifyAsync

public int OrderModifyAsync(Op type,
                            int ticket,
                            double price,
                            double stoploss,
                            double takeprofit,
                            java.time.LocalDateTime expiration)

Modification of characteristics for the previously opened position or pending orders without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

type - Operation type.

ticket - Unique number of the order ticket.

price - Price value.

stoploss - Stop loss level.

takeprofit - Take profit level.

expiration - Expiration time.

Returns:

Temporary ID to identify order until it get a ticket number.

Throws:

TradeContextBusyException - All trade connections are busy.

OrderClose

public Order OrderClose(java.lang.String symbol,
                        int ticket,
                        double volume,
                        double price,
                        int slippage)
                 throws TimeoutException

Close opened order.

Parameters:

symbol - Symbol for trading.

ticket - Unique number of the order ticket.

volume - Number of lots.

price - Preferred closing price.

slippage - Value of the maximum price slippage in points.

Returns:

Closed order.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderCloseAsync

public int OrderCloseAsync(java.lang.String symbol,
                           int ticket,
                           double volume,
                           double price,
                           int slippage)

Close opened order without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

symbol - Symbol for trading.

ticket - Unique number of the order ticket.

volume - Number of lots.

price - Preferred closing price.

slippage - Value of the maximum price slippage in points.

Returns:

Temporary ID to identify order until it get a ticket number.

Throws:

TradeContextBusyException - All trade connections are busy.

OrderCloseBy

public void OrderCloseBy(java.lang.String symbol,
                         int ticket1,
                         int ticket2)
                  throws TimeoutException,
                         TradeContextBusyException

Close of pair of opposite open orders.

Parameters:

symbol - Symbol for trading.

ticket1 - Unique number of the first order ticket.

ticket2 - Unique number of the two order ticket.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderCloseByAsync

public int OrderCloseByAsync(java.lang.String symbol,
                             int ticket1,
                             int ticket2)
                      throws TradeContextBusyException

Close of pair of opposite open orders without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

symbol - Symbol for trading.

ticket1 - Unique number of the first order ticket.

ticket2 - Unique number of the two order ticket.

Returns:

Temporary ID to identify order until it get a ticket number.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderMultipleCloseBy

public void OrderMultipleCloseBy(java.lang.String symbol)
                          throws TimeoutException,
                                 TradeContextBusyException

Close of multiple open orders.

Parameters:

symbol - Symbol for trading.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderMultipleCloseByAsync

public int OrderMultipleCloseByAsync(java.lang.String symbol)
                              throws TradeContextBusyException

Close of multiple open orders without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

symbol - Symbol for trading.

Returns:

Temporary ID to identify order until it get a ticket number.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderDelete

public void OrderDelete(int ticket,
                        Op type,
                        java.lang.String symbol,
                        double volume,
                        double price)
                 throws TimeoutException,
                        TradeContextBusyException

Delete pending order.

Parameters:

ticket - Unique number of the order ticket.

type - Operation type.

symbol - Symbol for trading.

volume - Number of lots.

price - Preferred deleting price.

Throws:

TradeContextBusyException - All trade connections are busy.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderDeleteAsync

public int OrderDeleteAsync(int ticket,
                            Op type,
                            java.lang.String symbol,
                            double volume,
                            double price)
                     throws TradeContextBusyException

Delete pending order without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

ticket - Unique number of the order ticket.

type - Operation type.

symbol - Symbol for trading.

volume - Number of lots.

price - Preferred deleting price.

Returns:

Temporary ID to identify order until it get a ticket number.

Throws:

TradeContextBusyException - All trade connections are busy.

OrderSend

public Order OrderSend(java.lang.String symbol,
                       Op operation,
                       double volume,
                       double price,
                       int slippage,
                       double stoploss,
                       double takeprofit,
                       java.lang.String comment,
                       int magic,
                       java.time.LocalDateTime expiration)
                throws TimeoutException,
                       TradeContextBusyException

The main function used to open a position or place a pending order.

Parameters:

symbol - Symbol for trading.

operation - Operation type.

volume - Number of lots.

price - Preferred price of the trade.

slippage - Maximum price slippage for buy or sell order.

stoploss - Stop loss level.

takeprofit - Take profit level.

comment - Order comment text. Last part of the comment may be changed by server.

magic - Order magic number. May be used as user defined identifier.

expiration - Order expiration time (for pending orders only).

Returns:

Opened order.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

RequoteException - Server cannot execute order(instant execution) at specified price. Check exception fields for latest server price.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderSend

public Order OrderSend(java.lang.String symbol,
                       Op operation,
                       double volume,
                       double price,
                       int slippage,
                       double stoploss,
                       double takeprofit)
                throws TimeoutException,
                       TradeContextBusyException

The main function used to open a position or place a pending order.

Parameters:

symbol - Symbol for trading.

operation - Operation type.

volume - Number of lots.

price - Preferred price of the trade.

slippage - Maximum price slippage for buy or sell order.

stoploss - Stop loss level.

takeprofit - Take profit level.

Returns:

Opened order.

Throws:

TradeContextBusyException - All trade connections are busy.

ServerException - Check exception message for details.

RequoteException - Server cannot execute order(instant execution) at specified price. Check exception fields for latest server price.

TimeoutException - No reply from server in TradeTimeout milliseconds.

OrderSendAsync

public int OrderSendAsync(java.lang.String symbol,
                          Op operation,
                          double volume,
                          double price,
                          int slippage,
                          double stoploss,
                          double takeprofit)
                   throws TimeoutException,
                          TradeContextBusyException

Send order without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

symbol - Symbol for trading.

operation - Operation type.

volume - Number of lots.

price - Preferred price of the trade.

slippage - Maximum price slippage for buy or sell order.

stoploss - Stop loss level.

takeprofit - Take profit level.

comment - Order comment text. Last part of the comment may be changed by server.

magic - Order magic number. May be used as user defined identifier.

expiration - Order expiration time (for pending orders only).

Returns:

Temporary ID to identify order until it get a ticket number from server.

Throws:

TradeContextBusyException - All trade connections are busy.

TimeoutException

OrderSendAsync

public int OrderSendAsync(java.lang.String symbol,
                          Op operation,
                          double volume,
                          double price,
                          int slippage,
                          double stoploss,
                          double takeprofit,
                          java.lang.String comment,
                          int magic,
                          java.time.LocalDateTime expiration)
                   throws TradeContextBusyException

Send order without awiting reply from server. Use OnOrderProgress event to get result.

Parameters:

symbol - Symbol for trading.

operation - Operation type.

volume - Number of lots.

price - Preferred price of the trade.

slippage - Maximum price slippage for buy or sell order.

stoploss - Stop loss level.

takeprofit - Take profit level.

comment - Order comment text. Last part of the comment may be changed by server.

magic - Order magic number. May be used as user defined identifier.

expiration - Order expiration time (for pending orders only).

Returns:

Temporary ID to identify order until it get a ticket number from server.

Throws:

TradeContextBusyException - All trade connections are busy.

onProgress

public void onProgress(byte[] buf,
                       ProgressType type,
                       int RequestID,
                       java.lang.Exception exception)