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

Class 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 Detail

      • OrderCancelTrade

        public OrderCancelTrade​(@NotNull
                        @NotNull com.caplin.trading.Trade backingTrade,
                        @NotNull
                        @NotNull 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 passed to Trade.sendEvent to trigger the CancelAck transition in the trade model of the adapter and client application

        Returns:
        A new instance of CancelAckTradeEvent.

      • sendCancelAckEvent

        public void sendCancelAckEvent​(@NotNull
                               @NotNull CancelAckTradeEvent event)

        Send a TradeEvent to trigger the CancelAck transition in the trade model of the adapter and client application

        Parameters:
        event - The event to send.

      • sendCancelAckEvent

        public void sendCancelAckEvent()

        Send a TradeEvent with no fields to trigger the CancelAck transition in the trade model of the adapter and client application

      • createErrorTradeEvent

        @NotNull
public @NotNull ErrorTradeEvent createErrorTradeEvent()

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Error transition in the trade model of the adapter and client application

        Returns:
        A new instance of ErrorTradeEvent.

      • sendErrorEvent

        public void sendErrorEvent​(@NotNull
                           @NotNull ErrorTradeEvent event)

        Send a TradeEvent to trigger the Error transition in the trade model of the adapter and client application

        Parameters:
        event - The event to send.

      • sendErrorEvent

        public void sendErrorEvent​(@NotNull
                           @NotNull Message message)

        Send a TradeEvent to trigger the Error transition in the trade model of the adapter and client application

        Parameters:
        message - The message to send.

      • createErrorTradeEvent

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

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Error transition in the trade model of the adapter and client application

        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 passed to Trade.sendEvent to trigger the CancelConfirm transition in the trade model of the adapter and client application

        Returns:
        A new instance of CancelConfirmTradeEvent.

      • sendCancelConfirmEvent

        public void sendCancelConfirmEvent​(@NotNull
                                   @NotNull CancelConfirmTradeEvent event)

        Send a TradeEvent to trigger the CancelConfirm transition in the trade model of the adapter and client application

        Parameters:
        event - The event to send.

      • sendCancelConfirmEvent

        public void sendCancelConfirmEvent()

        Send a TradeEvent with no fields to trigger the CancelConfirm transition in the trade model of the adapter and client application

      • createCancelRejectTradeEvent

        @NotNull
public @NotNull CancelRejectTradeEvent createCancelRejectTradeEvent()

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the CancelReject transition in the trade model of the adapter and client application

        Returns:
        A new instance of CancelRejectTradeEvent.

      • sendCancelRejectEvent

        public void sendCancelRejectEvent​(@NotNull
                                  @NotNull CancelRejectTradeEvent event)

        Send a TradeEvent to trigger the CancelReject transition in the trade model of the adapter and client application

        Parameters:
        event - The event to send.

      • createCancelPendingTradeEvent

        @NotNull
public @NotNull CancelPendingTradeEvent createCancelPendingTradeEvent()

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the CancelPending transition in the trade model of the adapter and client application

        Returns:
        A new instance of CancelPendingTradeEvent.

      • sendCancelPendingEvent

        public void sendCancelPendingEvent​(@NotNull
                                   @NotNull CancelPendingTradeEvent event)

        Send a TradeEvent to trigger the CancelPending transition in the trade model of the adapter and client application

        Parameters:
        event - The event to send.

      • sendCancelPendingEvent

        public void sendCancelPendingEvent()

        Send a TradeEvent with no fields to trigger the CancelPending transition in the trade model of the adapter and client application