Package velox.api.layer1.messages

Class Layer1ApiSetStopOrderOffsetMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

velox.api.layer1.messages.Layer1ApiSetStopOrderOffsetMessage

public final class Layer1ApiSetStopOrderOffsetMessage
extends Layer1ApiTradingMessageWithCallback

Request to change the Stop Order (stop-limit) price offset in the Trading Control Panel.
Send via Layer1ApiAdminProvider.sendUserMessage(Object)

This message is only processed if it was sent from a trading strategy (see Layer1TradingStrategy).

Works only when the Trading Control Panel is enabled.

The offset is expressed in ticks and only takes effect for stop-limit orders (i.e. when the stop order type is OrderType.LMT). A negative offset is only accepted for instruments whose provider reports support for it (see negativeStopLimitOffset in Layer1ApiProviderSupportedFeatures); if a negative offset is requested for a provider that does not support it, the request is rejected (the response will be ACTION_REJECTED) and the value is left unchanged.

See Also:

• Layer1ApiGetStopOrderOffsetMessage

Nested Class Summary

Nested classes/interfaces inherited from class velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

Layer1ApiTradingMessageWithCallback.Response, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener

Field Summary

Fields

Modifier and Type	Field	Description
final int	offset
static final int	STOP_ORDER_OFFSET_MAX_ABS_VALUE

Fields inherited from class velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

alias, listener

Constructor Summary

Constructors

Constructor	Description
Layer1ApiSetStopOrderOffsetMessage(String alias, int offset, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

STOP_ORDER_OFFSET_MAX_ABS_VALUE

public static final int STOP_ORDER_OFFSET_MAX_ABS_VALUE

See Also:

• Constant Field Values

offset

public final int offset

Constructor Details

Layer1ApiSetStopOrderOffsetMessage

public Layer1ApiSetStopOrderOffsetMessage(String alias,
 int offset,
 Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Parameters:

offset - the stop order (stop-limit) price offset to set, in ticks. The absolute value cannot exceed STOP_ORDER_OFFSET_MAX_ABS_VALUE

Method Details

toString

public String toString()

Overrides:

toString in class Object