Class CancelTrade


  • public class CancelTrade
    extends UserTrade

    A single CancelTrade 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
      CancelTrade​(@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 ConfirmTradeEvent createConfirmTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Confirm 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 ProcessingTradeEvent createProcessingTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Processing transition in the trade model of the adapter and client application
      @NotNull RejectTradeEvent createRejectTradeEvent()
      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Reject 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 sendConfirmEvent()
      Send a TradeEvent with no fields to trigger the Confirm transition in the trade model of the adapter and client application
      void sendConfirmEvent​(@NotNull ConfirmTradeEvent event)
      Send a TradeEvent to trigger the Confirm 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 sendProcessingEvent()
      Send a TradeEvent with no fields to trigger the Processing transition in the trade model of the adapter and client application
      void sendProcessingEvent​(@NotNull ProcessingTradeEvent event)
      Send a TradeEvent to trigger the Processing transition in the trade model of the adapter and client application
      void sendRejectEvent​(@NotNull RejectTradeEvent event)
      Send a TradeEvent to trigger the Reject 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

      • CancelTrade

        public CancelTrade​(@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

      • 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

      • createRejectTradeEvent

        @NotNull
        public @NotNull RejectTradeEvent createRejectTradeEvent()

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

        Returns:
        A new instance of RejectTradeEvent.
      • sendRejectEvent

        public void sendRejectEvent​(@NotNull
                                    @NotNull RejectTradeEvent event)

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

        Parameters:
        event - The event to send.
      • 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.
      • createProcessingTradeEvent

        @NotNull
        public @NotNull ProcessingTradeEvent createProcessingTradeEvent()

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

        Returns:
        A new instance of ProcessingTradeEvent.
      • sendProcessingEvent

        public void sendProcessingEvent​(@NotNull
                                        @NotNull ProcessingTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendProcessingEvent

        public void sendProcessingEvent()

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

      • createConfirmTradeEvent

        @NotNull
        public @NotNull ConfirmTradeEvent createConfirmTradeEvent()

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

        Returns:
        A new instance of ConfirmTradeEvent.
      • sendConfirmEvent

        public void sendConfirmEvent​(@NotNull
                                     @NotNull ConfirmTradeEvent event)

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

        Parameters:
        event - The event to send.
      • sendConfirmEvent

        public void sendConfirmEvent()

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