Package com.caplin.generated.motif.fx.trading.esp

Class ESPTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.trading.esp.ESPTrade

public class ESPTrade
extends UserTrade

A single ESPTrade 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
ESPTrade(@NotNull com.caplin.trading.Trade backingTrade, @NotNull ScheduledExecutorService executorService)	Constructor used by the generated code.

Method Summary

Modifier and Type	Method	Description
@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
@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 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
@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
@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
@NotNull TradeConfirmationTradeEvent	createTradeConfirmationTradeEvent()	Create a TradeEvent that can be passed to Trade.sendEvent to trigger the TradeConfirmation transition in the trade model of the adapter and client application
@NotNull TradeConfirmationTradeEvent	createTradeConfirmationTradeEvent(@NotNull Message message)	Create a TradeEvent that can be passed to Trade.sendEvent to trigger the TradeConfirmation transition in the trade model of the adapter and client application
void	sendClientCloseAckEvent()	Send a TradeEvent with no fields to trigger the ClientCloseAck transition in the trade model of the adapter and client application
void	sendClientCloseAckEvent(@NotNull ClientCloseAckTradeEvent event)	Send a TradeEvent to trigger the ClientCloseAck 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	sendHoldEvent()	Send a TradeEvent with no fields to trigger the Hold transition in the trade model of the adapter and client application
void	sendHoldEvent(@NotNull HoldTradeEvent event)	Send a TradeEvent to trigger the Hold transition in the trade model of the adapter and client application
void	sendPickUpEvent()	Send a TradeEvent with no fields to trigger the PickUp transition in the trade model of the adapter and client application
void	sendPickUpEvent(@NotNull PickUpTradeEvent event)	Send a TradeEvent to trigger the PickUp 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(@NotNull SubmitAckTradeEvent event)	Send a TradeEvent to trigger the SubmitAck transition in the trade model of the adapter and client application
void	sendTradeConfirmationEvent(@NotNull TradeConfirmationTradeEvent event)	Send a TradeEvent to trigger the TradeConfirmation transition in the trade model of the adapter and client application
void	sendTradeConfirmationEvent(@NotNull Message message)	Send a TradeEvent to trigger the TradeConfirmation transition in the trade model of the adapter and client application

Methods inherited from class com.caplin.motif.UserTrade

getBackingTrade, getExecutorService, getRequestID, getUsername, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ESPTrade

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

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.

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.

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

createTradeConfirmationTradeEvent

@NotNull
public @NotNull TradeConfirmationTradeEvent createTradeConfirmationTradeEvent()

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

Returns:

A new instance of TradeConfirmationTradeEvent.

sendTradeConfirmationEvent

public void sendTradeConfirmationEvent(@NotNull
                                       @NotNull TradeConfirmationTradeEvent event)

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

Parameters:

event - The event to send.

sendTradeConfirmationEvent

public void sendTradeConfirmationEvent(@NotNull
                                       @NotNull Message message)

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

Parameters:

message - The message to send.

createTradeConfirmationTradeEvent

@NotNull
public @NotNull TradeConfirmationTradeEvent createTradeConfirmationTradeEvent(@NotNull
                                                                              @NotNull Message message)

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

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

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