Package velox.api.layer1.messages

Class Layer1ApiSetTrailingStopMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiTradingMessageWithCallback

velox.api.layer1.messages.Layer1ApiSetTrailingStopMessage

public final class Layer1ApiSetTrailingStopMessage
extends Layer1ApiTradingMessageWithCallback

Request to change the Trailing Stop settings 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.

See Also:

• Layer1ApiGetTrailingStopMessage

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 boolean	enabled
final int	trailingStep

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

alias, listener

Constructor Summary

Constructors

Constructor	Description
Layer1ApiSetTrailingStopMessage(String alias, int trailingStep, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)	Creates a message to enable trailing stop with the given trailing step.
Layer1ApiSetTrailingStopMessage(String alias, Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)	Creates a message to disable trailing stop.

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

enabled

public final boolean enabled

trailingStep

public final int trailingStep

Constructor Details

Layer1ApiSetTrailingStopMessage

public Layer1ApiSetTrailingStopMessage(String alias,
 int trailingStep,
 Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Creates a message to enable trailing stop with the given trailing step.

The trailingStep must be greater than 0 - enabling trailing stop without a step is meaningless. To turn trailing stop off, use Layer1ApiSetTrailingStopMessage(String, TradingMessageResponseListener) instead.

Parameters:

trailingStep - trailing step in ticks (> 0)

Throws:

IllegalArgumentException - if trailingStep is not greater than 0

Layer1ApiSetTrailingStopMessage

public Layer1ApiSetTrailingStopMessage(String alias,
 Layer1ApiTradingMessageWithCallback.TradingMessageResponseListener listener)

Creates a message to disable trailing stop. The trailing step is not applicable and is set to 0.

Method Details

toString

public String toString()

Overrides:

toString in class Object