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

Class ValidateTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.trading.validate.ValidateTrade

public class ValidateTrade
extends UserTrade

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

Method Summary

Modifier and Type	Method	Description
@NotNull ClientCloseAckTradeEvent	createClientCloseAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the ClientCloseAck state.
@NotNull ErrorTradeEvent	createErrorTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
@NotNull ValidationTradeEvent	createValidationTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Validation state.
void	sendClientCloseAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the ClientCloseAck state.
void	sendClientCloseAckEvent(@NotNull ClientCloseAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the ClientCloseAck state.
void	sendErrorEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the Error state.
void	sendErrorEvent(@NotNull ErrorTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Error state.
void	sendValidationEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the Validation state.
void	sendValidationEvent(@NotNull ValidationTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Validation state.

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

ValidateTrade

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

createValidationTradeEvent

@NotNull
public @NotNull ValidationTradeEvent createValidationTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the Validation state.

Returns:

A new instance of ValidationTradeEvent.

sendValidationEvent

public void sendValidationEvent(@NotNull
                                @NotNull ValidationTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the Validation state.

Parameters:

event - The event to send.

sendValidationEvent

public void sendValidationEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the Validation state.

createErrorTradeEvent

@NotNull
public @NotNull ErrorTradeEvent createErrorTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the Error state.

Returns:

A new instance of ErrorTradeEvent.

sendErrorEvent

public void sendErrorEvent(@NotNull
                           @NotNull ErrorTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the Error state.

Parameters:

event - The event to send.

sendErrorEvent

public void sendErrorEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the Error state.

createClientCloseAckTradeEvent

@NotNull
public @NotNull ClientCloseAckTradeEvent createClientCloseAckTradeEvent()

Create a TradeEvent that can be used to trigger the trade to transition into the ClientCloseAck state.

Returns:

A new instance of ClientCloseAckTradeEvent.

sendClientCloseAckEvent

public void sendClientCloseAckEvent(@NotNull
                                    @NotNull ClientCloseAckTradeEvent event)

Send a TradeEvent to trigger the trade to transition into the ClientCloseAck state.

Parameters:

event - The event to send.

sendClientCloseAckEvent

public void sendClientCloseAckEvent()

Send a TradeEvent with no fields to trigger the trade to transition into the ClientCloseAck state.