Class OrderDeletionTrade


  • public class OrderDeletionTrade
    extends UserTrade

    A single OrderDeletionTrade 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
      OrderDeletionTrade​(@NotNull com.caplin.trading.Trade backingTrade, @NotNull java.util.concurrent.ScheduledExecutorService executorService)
      Constructor used by the generated code.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NotNull DeleteAckTradeEvent createDeleteAckTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the DeleteAck transition in the trade model of the adapter and client application
      @NotNull DeletedTradeEvent createDeletedTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Deleted transition in the trade model of the adapter and client application
      @NotNull DeletePendingTradeEvent createDeletePendingTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the DeletePending transition in the trade model of the adapter and client application
      @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
      @NotNull ErrorTradeEvent createErrorTradeEvent​(@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
      void sendDeleteAckEvent()
      Send a TradeEvent with no fields to trigger the DeleteAck transition in the trade model of the adapter and client application
      void sendDeleteAckEvent​(@NotNull DeleteAckTradeEvent event)
      Send a TradeEvent to trigger the DeleteAck transition in the trade model of the adapter and client application
      void sendDeletedEvent()
      Send a TradeEvent with no fields to trigger the Deleted transition in the trade model of the adapter and client application
      void sendDeletedEvent​(@NotNull DeletedTradeEvent event)
      Send a TradeEvent to trigger the Deleted transition in the trade model of the adapter and client application
      void sendDeletePendingEvent()
      Send a TradeEvent with no fields to trigger the DeletePending transition in the trade model of the adapter and client application
      void sendDeletePendingEvent​(@NotNull DeletePendingTradeEvent event)
      Send a TradeEvent to trigger the DeletePending transition in the trade model of the adapter and client application
      void sendErrorEvent​(@NotNull ErrorTradeEvent event)
      Send a TradeEvent to trigger the Error transition in the trade model of the adapter and client application
      void sendErrorEvent​(@NotNull Message message)
      Send a TradeEvent to trigger the Error transition in the trade model of the adapter and client application
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • OrderDeletionTrade

        public OrderDeletionTrade​(@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 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.
      • createDeleteAckTradeEvent

        @NotNull
        public @NotNull DeleteAckTradeEvent createDeleteAckTradeEvent()

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

        Returns:
        A new instance of DeleteAckTradeEvent.
      • sendDeleteAckEvent

        public void sendDeleteAckEvent​(@NotNull
                                       @NotNull DeleteAckTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendDeleteAckEvent

        public void sendDeleteAckEvent()

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

      • createDeletedTradeEvent

        @NotNull
        public @NotNull DeletedTradeEvent createDeletedTradeEvent()

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

        Returns:
        A new instance of DeletedTradeEvent.
      • sendDeletedEvent

        public void sendDeletedEvent​(@NotNull
                                     @NotNull DeletedTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendDeletedEvent

        public void sendDeletedEvent()

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

      • createDeletePendingTradeEvent

        @NotNull
        public @NotNull DeletePendingTradeEvent createDeletePendingTradeEvent()

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

        Returns:
        A new instance of DeletePendingTradeEvent.
      • sendDeletePendingEvent

        public void sendDeletePendingEvent​(@NotNull
                                           @NotNull DeletePendingTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendDeletePendingEvent

        public void sendDeletePendingEvent()

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