Class OrderSubmissionTrade

java.lang.Object
com.caplin.motif.UserTrade
com.caplin.generated.motif.fx.orders.ordersubmission.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 Details

    • OrderSubmissionTrade

      public OrderSubmissionTrade(@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 Details

    • 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

    • createWarningTradeEvent

      @NotNull public @NotNull WarningTradeEvent createWarningTradeEvent()

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

      Returns:
      A new instance of WarningTradeEvent.
    • sendWarningEvent

      public void sendWarningEvent(@NotNull @NotNull WarningTradeEvent event)

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

      Parameters:
      event - The event to send.
    • sendWarningEvent

      public void sendWarningEvent(@NotNull @NotNull Message message)

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

      Parameters:
      message - The message to send.
    • createWarningTradeEvent

      @NotNull public @NotNull WarningTradeEvent createWarningTradeEvent(@NotNull @NotNull Message message)

      Create a TradeEvent that can be passed to Trade.sendEvent to trigger the Warning 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 WarningTradeEvent.
    • 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.
    • createAcceptWarningAckTradeEvent

      @NotNull public @NotNull AcceptWarningAckTradeEvent createAcceptWarningAckTradeEvent()

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

      Returns:
      A new instance of AcceptWarningAckTradeEvent.
    • sendAcceptWarningAckEvent

      public void sendAcceptWarningAckEvent(@NotNull @NotNull AcceptWarningAckTradeEvent event)

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

      Parameters:
      event - The event to send.
    • sendAcceptWarningAckEvent

      public void sendAcceptWarningAckEvent()

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

    • createClientCloseAckTradeEvent

      @NotNull public @NotNull ClientCloseAckTradeEvent createClientCloseAckTradeEvent()

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

      Returns:
      A new instance of ClientCloseAckTradeEvent.
    • sendClientCloseAckEvent

      public void sendClientCloseAckEvent(@NotNull @NotNull ClientCloseAckTradeEvent event)

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

      Parameters:
      event - The event to send.
    • sendClientCloseAckEvent

      public void sendClientCloseAckEvent()

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

    • 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