Package com.caplin.generated.motif.fx.orders.editstrategy

Class EditStrategyTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.orders.editstrategy.EditStrategyTrade

public class EditStrategyTrade
extends UserTrade

A single EditStrategyTrade active in the system.

A Trade is initiated by a client and is tied to a TradeChannel. The lifecycle of a Trade consists of a number of messages, represented by TradeEvents, being sent between the client and the Trading System in both directions. These messages cause the Trade to transition between a number of predefined states.

Trades are comprised of one or more trade legs, which each leg representing the exchange of a financial instrument and the resultant cash flow. It is possible to add, remove and update trades from the client or from the TradingDataSource.

A Trade is uniquely identified in two ways: by RequestId set by the client and a TradeId set by the Trading System.

Constructor Summary

Constructors

Constructor	Description
EditStrategyTrade(@NotNull com.caplin.trading.Trade backingTrade, @NotNull java.util.concurrent.ScheduledExecutorService executorService)	Constructor used by the generated code.

Method Summary

Modifier and Type	Method	Description
@NotNull ClientCloseAckTradeEvent	createClientCloseAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the ClientCloseAck state.
@NotNull EditAcceptTradeEvent	createEditAcceptTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the EditAccept state.
@NotNull EditAcceptTradeEvent	createEditAcceptTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the EditAccept state.
@NotNull EditOpenAckTradeEvent	createEditOpenAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the EditOpenAck state.
@NotNull ErrorTradeEvent	createErrorTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
@NotNull ErrorTradeEvent	createErrorTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
@NotNull RefreshTradeEvent	createRefreshTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Refresh state.
@NotNull SaveAcceptTradeEvent	createSaveAcceptTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the SaveAccept state.
@NotNull SaveAcceptTradeEvent	createSaveAcceptTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the SaveAccept state.
@NotNull SaveAndCompleteTradeEvent	createSaveAndCompleteTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the SaveAndComplete state.
@NotNull SaveAndCompleteTradeEvent	createSaveAndCompleteTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the SaveAndComplete state.
@NotNull ValidationErrorTradeEvent	createValidationErrorTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the ValidationError state.
@NotNull ValidationErrorTradeEvent	createValidationErrorTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the ValidationError state.
void	sendClientCloseAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the ClientCloseAck state.
void	sendClientCloseAckEvent(@NotNull ClientCloseAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the ClientCloseAck state.
void	sendEditAcceptEvent(@NotNull EditAcceptTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the EditAccept state.
void	sendEditAcceptEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the EditAccept state.
void	sendEditOpenAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the EditOpenAck state.
void	sendEditOpenAckEvent(@NotNull EditOpenAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the EditOpenAck state.
void	sendErrorEvent(@NotNull ErrorTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Error state.
void	sendErrorEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the Error state.
void	sendRefreshEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the Refresh state.
void	sendRefreshEvent(@NotNull RefreshTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Refresh state.
void	sendSaveAcceptEvent(@NotNull SaveAcceptTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the SaveAccept state.
void	sendSaveAcceptEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the SaveAccept state.
void	sendSaveAndCompleteEvent(@NotNull SaveAndCompleteTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the SaveAndComplete state.
void	sendSaveAndCompleteEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the SaveAndComplete state.
void	sendValidationErrorEvent(@NotNull ValidationErrorTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the ValidationError state.
void	sendValidationErrorEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the ValidationError state.

Methods inherited from class com.caplin.motif.UserTrade

getBackingTrade, getExecutorService, getRequestID, getUsername, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EditStrategyTrade

public EditStrategyTrade(@NotNull
                         @NotNull com.caplin.trading.Trade backingTrade,
                         @NotNull
                         @NotNull java.util.concurrent.ScheduledExecutorService executorService)

Constructor used by the generated code.

Parameters:

backingTrade - To be used for the parent constructor

executorService - To be used for the parent constructor (What service is going execute the backingTrade)

Method Detail

createErrorTradeEvent

@NotNull
public @NotNull ErrorTradeEvent createErrorTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the Error state.

Returns:

A new instance of ErrorTradeEvent.

sendErrorEvent

public void sendErrorEvent(@NotNull
                           @NotNull ErrorTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the Error state.

Parameters:

event - The event to send.

sendErrorEvent

public void sendErrorEvent(@NotNull
                           @NotNull Message message)

Send a TradeEvent to trigger the trade to transition into the Error state.

Parameters:

message - The message to send.

createErrorTradeEvent

@NotNull
public @NotNull ErrorTradeEvent createErrorTradeEvent(@NotNull
                                                      @NotNull Message message)

Create a TradeEvent that can be used to trigger the trade to transition into the Error state.

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of ErrorTradeEvent.

createEditOpenAckTradeEvent

@NotNull
public @NotNull EditOpenAckTradeEvent createEditOpenAckTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the EditOpenAck state.

Returns:

A new instance of EditOpenAckTradeEvent.

sendEditOpenAckEvent

public void sendEditOpenAckEvent(@NotNull
                                 @NotNull EditOpenAckTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the EditOpenAck state.

Parameters:

event - The event to send.

sendEditOpenAckEvent

public void sendEditOpenAckEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the EditOpenAck state.

createClientCloseAckTradeEvent

@NotNull
public @NotNull ClientCloseAckTradeEvent createClientCloseAckTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the ClientCloseAck state.

Returns:

A new instance of ClientCloseAckTradeEvent.

sendClientCloseAckEvent

public void sendClientCloseAckEvent(@NotNull
                                    @NotNull ClientCloseAckTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the ClientCloseAck state.

Parameters:

event - The event to send.

sendClientCloseAckEvent

public void sendClientCloseAckEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the ClientCloseAck state.

createRefreshTradeEvent

@NotNull
public @NotNull RefreshTradeEvent createRefreshTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the Refresh state.

Returns:

A new instance of RefreshTradeEvent.

sendRefreshEvent

public void sendRefreshEvent(@NotNull
                             @NotNull RefreshTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the Refresh state.

Parameters:

event - The event to send.

sendRefreshEvent

public void sendRefreshEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the Refresh state.

createEditAcceptTradeEvent

@NotNull
public @NotNull EditAcceptTradeEvent createEditAcceptTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the EditAccept state.

Returns:

A new instance of EditAcceptTradeEvent.

sendEditAcceptEvent

public void sendEditAcceptEvent(@NotNull
                                @NotNull EditAcceptTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the EditAccept state.

Parameters:

event - The event to send.

sendEditAcceptEvent

public void sendEditAcceptEvent(@NotNull
                                @NotNull Message message)

Send a TradeEvent to trigger the trade to transition into the EditAccept state.

Parameters:

message - The message to send.

createEditAcceptTradeEvent

@NotNull
public @NotNull EditAcceptTradeEvent createEditAcceptTradeEvent(@NotNull
                                                                @NotNull Message message)

Create a TradeEvent that can be used to trigger the trade to transition into the EditAccept state.

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of EditAcceptTradeEvent.

createSaveAndCompleteTradeEvent

@NotNull
public @NotNull SaveAndCompleteTradeEvent createSaveAndCompleteTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the SaveAndComplete state.

Returns:

A new instance of SaveAndCompleteTradeEvent.

sendSaveAndCompleteEvent

public void sendSaveAndCompleteEvent(@NotNull
                                     @NotNull SaveAndCompleteTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the SaveAndComplete state.

Parameters:

event - The event to send.

sendSaveAndCompleteEvent

public void sendSaveAndCompleteEvent(@NotNull
                                     @NotNull Message message)

Send a TradeEvent to trigger the trade to transition into the SaveAndComplete state.

Parameters:

message - The message to send.

createSaveAndCompleteTradeEvent

@NotNull
public @NotNull SaveAndCompleteTradeEvent createSaveAndCompleteTradeEvent(@NotNull
                                                                          @NotNull Message message)

Create a TradeEvent that can be used to trigger the trade to transition into the SaveAndComplete state.

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of SaveAndCompleteTradeEvent.

createSaveAcceptTradeEvent

@NotNull
public @NotNull SaveAcceptTradeEvent createSaveAcceptTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the SaveAccept state.

Returns:

A new instance of SaveAcceptTradeEvent.

sendSaveAcceptEvent

public void sendSaveAcceptEvent(@NotNull
                                @NotNull SaveAcceptTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the SaveAccept state.

Parameters:

event - The event to send.

sendSaveAcceptEvent

public void sendSaveAcceptEvent(@NotNull
                                @NotNull Message message)

Send a TradeEvent to trigger the trade to transition into the SaveAccept state.

Parameters:

message - The message to send.

createSaveAcceptTradeEvent

@NotNull
public @NotNull SaveAcceptTradeEvent createSaveAcceptTradeEvent(@NotNull
                                                                @NotNull Message message)

Create a TradeEvent that can be used to trigger the trade to transition into the SaveAccept state.

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of SaveAcceptTradeEvent.

createValidationErrorTradeEvent

@NotNull
public @NotNull ValidationErrorTradeEvent createValidationErrorTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the ValidationError state.

Returns:

A new instance of ValidationErrorTradeEvent.

sendValidationErrorEvent

public void sendValidationErrorEvent(@NotNull
                                     @NotNull ValidationErrorTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the ValidationError state.

Parameters:

event - The event to send.

sendValidationErrorEvent

public void sendValidationErrorEvent(@NotNull
                                     @NotNull Message message)

Send a TradeEvent to trigger the trade to transition into the ValidationError state.

Parameters:

message - The message to send.

createValidationErrorTradeEvent

@NotNull
public @NotNull ValidationErrorTradeEvent createValidationErrorTradeEvent(@NotNull
                                                                          @NotNull Message message)

Create a TradeEvent that can be used to trigger the trade to transition into the ValidationError state.

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of ValidationErrorTradeEvent.