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

Class OrderCancelTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.orders.ordercancel.OrderCancelTrade

public class OrderCancelTrade
extends UserTrade

A single OrderCancelTrade 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
OrderCancelTrade(@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 CancelAckTradeEvent	createCancelAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the CancelAck state.
@NotNull CancelConfirmTradeEvent	createCancelConfirmTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the CancelConfirm state.
@NotNull CancelPendingTradeEvent	createCancelPendingTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the CancelPending state.
@NotNull CancelRejectTradeEvent	createCancelRejectTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the CancelReject 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.
void	sendCancelAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the CancelAck state.
void	sendCancelAckEvent(@NotNull CancelAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the CancelAck state.
void	sendCancelConfirmEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the CancelConfirm state.
void	sendCancelConfirmEvent(@NotNull CancelConfirmTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the CancelConfirm state.
void	sendCancelPendingEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the CancelPending state.
void	sendCancelPendingEvent(@NotNull CancelPendingTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the CancelPending state.
void	sendCancelRejectEvent(@NotNull CancelRejectTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the CancelReject 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.

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

OrderCancelTrade

public OrderCancelTrade(@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

createCancelAckTradeEvent

@NotNull
public @NotNull CancelAckTradeEvent createCancelAckTradeEvent()

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

Returns:

A new instance of CancelAckTradeEvent.

sendCancelAckEvent

public void sendCancelAckEvent(@NotNull
                               @NotNull CancelAckTradeEvent event)

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

Parameters:

event - The event to send.

sendCancelAckEvent

public void sendCancelAckEvent()

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

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.

createCancelConfirmTradeEvent

@NotNull
public @NotNull CancelConfirmTradeEvent createCancelConfirmTradeEvent()

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

Returns:

A new instance of CancelConfirmTradeEvent.

sendCancelConfirmEvent

public void sendCancelConfirmEvent(@NotNull
                                   @NotNull CancelConfirmTradeEvent event)

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

Parameters:

event - The event to send.

sendCancelConfirmEvent

public void sendCancelConfirmEvent()

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

createCancelRejectTradeEvent

@NotNull
public @NotNull CancelRejectTradeEvent createCancelRejectTradeEvent()

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

Returns:

A new instance of CancelRejectTradeEvent.

sendCancelRejectEvent

public void sendCancelRejectEvent(@NotNull
                                  @NotNull CancelRejectTradeEvent event)

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

Parameters:

event - The event to send.

createCancelPendingTradeEvent

@NotNull
public @NotNull CancelPendingTradeEvent createCancelPendingTradeEvent()

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

Returns:

A new instance of CancelPendingTradeEvent.

sendCancelPendingEvent

public void sendCancelPendingEvent(@NotNull
                                   @NotNull CancelPendingTradeEvent event)

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

Parameters:

event - The event to send.

sendCancelPendingEvent

public void sendCancelPendingEvent()

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