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

Class OrderChangeStateTrade

java.lang.Object
com.caplin.motif.UserTrade
com.caplin.generated.motif.fx.orders.orderchangestate.OrderChangeStateTrade
public class OrderChangeStateTrade extends UserTrade

A single OrderChangeStateTrade 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

    • OrderChangeStateTrade

      public OrderChangeStateTrade(@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

    • createChangeStateAckTradeEvent

      @NotNull public @NotNull ChangeStateAckTradeEvent createChangeStateAckTradeEvent()

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

      Returns:
      A new instance of ChangeStateAckTradeEvent.

    • sendChangeStateAckEvent

      public void sendChangeStateAckEvent(@NotNull @NotNull ChangeStateAckTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendChangeStateAckEvent

      public void sendChangeStateAckEvent()

      Send a TradeEvent with no fields to trigger the ChangeStateAck 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.

    • createChangeStateConfirmTradeEvent

      @NotNull public @NotNull ChangeStateConfirmTradeEvent createChangeStateConfirmTradeEvent()

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

      Returns:
      A new instance of ChangeStateConfirmTradeEvent.

    • sendChangeStateConfirmEvent

      public void sendChangeStateConfirmEvent(@NotNull @NotNull ChangeStateConfirmTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendChangeStateConfirmEvent

      public void sendChangeStateConfirmEvent()

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

    • createChangeStateRejectTradeEvent

      @NotNull public @NotNull ChangeStateRejectTradeEvent createChangeStateRejectTradeEvent()

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

      Returns:
      A new instance of ChangeStateRejectTradeEvent.

    • sendChangeStateRejectEvent

      public void sendChangeStateRejectEvent(@NotNull @NotNull ChangeStateRejectTradeEvent event)

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

      Parameters:
      event - The event to send.

    • createChangeStatePendingTradeEvent

      @NotNull public @NotNull ChangeStatePendingTradeEvent createChangeStatePendingTradeEvent()

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

      Returns:
      A new instance of ChangeStatePendingTradeEvent.

    • sendChangeStatePendingEvent

      public void sendChangeStatePendingEvent(@NotNull @NotNull ChangeStatePendingTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendChangeStatePendingEvent

      public void sendChangeStatePendingEvent()

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