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

Class PostTradeAllocationTrade

java.lang.Object
com.caplin.motif.UserTrade
com.caplin.generated.motif.fx.orders.posttradeallocation.PostTradeAllocationTrade
public class PostTradeAllocationTrade extends UserTrade

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

    • PostTradeAllocationTrade

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

    • createAllocationConfirmationTradeEvent

      @NotNull public @NotNull AllocationConfirmationTradeEvent createAllocationConfirmationTradeEvent()

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

      Returns:
      A new instance of AllocationConfirmationTradeEvent.

    • sendAllocationConfirmationEvent

      public void sendAllocationConfirmationEvent(@NotNull @NotNull AllocationConfirmationTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendAllocationConfirmationEvent

      public void sendAllocationConfirmationEvent()

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

    • createHoldTradeEvent

      @NotNull public @NotNull HoldTradeEvent createHoldTradeEvent()

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

      Returns:
      A new instance of HoldTradeEvent.

    • sendHoldEvent

      public void sendHoldEvent(@NotNull @NotNull HoldTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendHoldEvent

      public void sendHoldEvent()

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

    • sendRejectEvent

      public void sendRejectEvent(@NotNull @NotNull Message message)

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

      Parameters:
      message - The message to send.

    • createRejectTradeEvent

      @NotNull public @NotNull RejectTradeEvent createRejectTradeEvent(@NotNull @NotNull Message message)

      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

      Parameters:
      message - a Message to be passed to the TradeEvent
      Returns:
      A new instance of RejectTradeEvent.

    • 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

    • createPickUpTradeEvent

      @NotNull public @NotNull PickUpTradeEvent createPickUpTradeEvent()

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

      Returns:
      A new instance of PickUpTradeEvent.

    • sendPickUpEvent

      public void sendPickUpEvent(@NotNull @NotNull PickUpTradeEvent event)

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

      Parameters:
      event - The event to send.

    • sendPickUpEvent

      public void sendPickUpEvent()

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