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

Class EditStrategyTrade

  • public class EditStrategyTrade
extends UserTrade

    A single EditStrategyTrade 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 Detail

      • EditStrategyTrade

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

      • createEditOpenAckTradeEvent

        @NotNull
public @NotNull EditOpenAckTradeEvent createEditOpenAckTradeEvent()

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

        Returns:
        A new instance of EditOpenAckTradeEvent.

      • sendEditOpenAckEvent

        public void sendEditOpenAckEvent​(@NotNull
                                 @NotNull EditOpenAckTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendEditOpenAckEvent

        public void sendEditOpenAckEvent()

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

      • createRefreshTradeEvent

        @NotNull
public @NotNull RefreshTradeEvent createRefreshTradeEvent()

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

        Returns:
        A new instance of RefreshTradeEvent.

      • sendRefreshEvent

        public void sendRefreshEvent​(@NotNull
                             @NotNull RefreshTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendRefreshEvent

        public void sendRefreshEvent()

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

      • createEditAcceptTradeEvent

        @NotNull
public @NotNull EditAcceptTradeEvent createEditAcceptTradeEvent()

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

        Returns:
        A new instance of EditAcceptTradeEvent.

      • sendEditAcceptEvent

        public void sendEditAcceptEvent​(@NotNull
                                @NotNull EditAcceptTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendEditAcceptEvent

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

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

        Parameters:
        message - The message to send.

      • createEditAcceptTradeEvent

        @NotNull
public @NotNull EditAcceptTradeEvent createEditAcceptTradeEvent​(@NotNull
                                                                @NotNull Message message)

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the EditAccept 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 EditAcceptTradeEvent.

      • createSaveAndCompleteTradeEvent

        @NotNull
public @NotNull SaveAndCompleteTradeEvent createSaveAndCompleteTradeEvent()

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

        Returns:
        A new instance of SaveAndCompleteTradeEvent.

      • sendSaveAndCompleteEvent

        public void sendSaveAndCompleteEvent​(@NotNull
                                     @NotNull SaveAndCompleteTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendSaveAndCompleteEvent

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

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

        Parameters:
        message - The message to send.

      • createSaveAndCompleteTradeEvent

        @NotNull
public @NotNull SaveAndCompleteTradeEvent createSaveAndCompleteTradeEvent​(@NotNull
                                                                          @NotNull Message message)

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the SaveAndComplete 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 SaveAndCompleteTradeEvent.

      • createSaveAcceptTradeEvent

        @NotNull
public @NotNull SaveAcceptTradeEvent createSaveAcceptTradeEvent()

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

        Returns:
        A new instance of SaveAcceptTradeEvent.

      • sendSaveAcceptEvent

        public void sendSaveAcceptEvent​(@NotNull
                                @NotNull SaveAcceptTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendSaveAcceptEvent

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

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

        Parameters:
        message - The message to send.

      • createSaveAcceptTradeEvent

        @NotNull
public @NotNull SaveAcceptTradeEvent createSaveAcceptTradeEvent​(@NotNull
                                                                @NotNull Message message)

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the SaveAccept 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 SaveAcceptTradeEvent.

      • createValidationErrorTradeEvent

        @NotNull
public @NotNull ValidationErrorTradeEvent createValidationErrorTradeEvent()

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

        Returns:
        A new instance of ValidationErrorTradeEvent.

      • sendValidationErrorEvent

        public void sendValidationErrorEvent​(@NotNull
                                     @NotNull ValidationErrorTradeEvent event)

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

        Parameters:
        event - The event to send.

      • sendValidationErrorEvent

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

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

        Parameters:
        message - The message to send.

      • createValidationErrorTradeEvent

        @NotNull
public @NotNull ValidationErrorTradeEvent createValidationErrorTradeEvent​(@NotNull
                                                                          @NotNull Message message)

        Create a TradeEvent that can be passed to Trade.sendEvent to trigger the ValidationError 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 ValidationErrorTradeEvent.