Class OrderSubmissionTrade


  • public class OrderSubmissionTrade
    extends UserTrade

    A single OrderSubmissionTrade 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
      OrderSubmissionTrade​(@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 AcceptingTradeEvent createAcceptingTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Accepting transition in the trade model of the adapter and client application
      @NotNull AcceptTradeEvent createAcceptTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Accept transition in the trade model of the adapter and client application
      @NotNull AcceptTradeEvent createAcceptTradeEvent​(@NotNull Message message)
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Accept 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
      @NotNull SubmitAckTradeEvent createSubmitAckTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the SubmitAck transition in the trade model of the adapter and client application
      void sendAcceptEvent​(@NotNull AcceptTradeEvent event)
      Send a TradeEvent to trigger the Accept transition in the trade model of the adapter and client application
      void sendAcceptEvent​(@NotNull Message message)
      Send a TradeEvent to trigger the Accept transition in the trade model of the adapter and client application
      void sendAcceptingEvent()
      Send a TradeEvent with no fields to trigger the Accepting transition in the trade model of the adapter and client application
      void sendAcceptingEvent​(@NotNull AcceptingTradeEvent event)
      Send a TradeEvent to trigger the Accepting 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
      void sendSubmitAckEvent()
      Send a TradeEvent with no fields to trigger the SubmitAck transition in the trade model of the adapter and client application
      void sendSubmitAckEvent​(@NotNull SubmitAckTradeEvent event)
      Send a TradeEvent to trigger the SubmitAck 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

      • OrderSubmissionTrade

        public OrderSubmissionTrade​(@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.
      • createSubmitAckTradeEvent

        @NotNull
        public @NotNull SubmitAckTradeEvent createSubmitAckTradeEvent()

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

        Returns:
        A new instance of SubmitAckTradeEvent.
      • sendSubmitAckEvent

        public void sendSubmitAckEvent​(@NotNull
                                       @NotNull SubmitAckTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendSubmitAckEvent

        public void sendSubmitAckEvent()

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

      • createAcceptTradeEvent

        @NotNull
        public @NotNull AcceptTradeEvent createAcceptTradeEvent()

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

        Returns:
        A new instance of AcceptTradeEvent.
      • sendAcceptEvent

        public void sendAcceptEvent​(@NotNull
                                    @NotNull AcceptTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendAcceptEvent

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

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

        Parameters:
        message - The message to send.
      • createAcceptTradeEvent

        @NotNull
        public @NotNull AcceptTradeEvent createAcceptTradeEvent​(@NotNull
                                                                @NotNull Message message)

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Accept 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 AcceptTradeEvent.
      • createAcceptingTradeEvent

        @NotNull
        public @NotNull AcceptingTradeEvent createAcceptingTradeEvent()

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

        Returns:
        A new instance of AcceptingTradeEvent.
      • sendAcceptingEvent

        public void sendAcceptingEvent​(@NotNull
                                       @NotNull AcceptingTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendAcceptingEvent

        public void sendAcceptingEvent()

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