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

Class SalesInterventionTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.trading.salesintervention.SalesInterventionTrade

public class SalesInterventionTrade
extends UserTrade

A single SalesInterventionTrade 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
SalesInterventionTrade(@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 ClientRejectTradeEvent	createClientRejectTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the ClientReject state.
@NotNull ErrorTradeEvent	createErrorTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
@NotNull HoldAckTradeEvent	createHoldAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the HoldAck state.
@NotNull PickUpAckTradeEvent	createPickUpAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the PickUpAck state.
@NotNull PickUpAckTradeEvent	createPickUpAckTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the PickUpAck state.
@NotNull PickUpRejectedTradeEvent	createPickUpRejectedTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the PickUpRejected state.
@NotNull PriceUnavailableTradeEvent	createPriceUnavailableTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the PriceUnavailable state.
@NotNull PriceUnavailableTradeEvent	createPriceUnavailableTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the PriceUnavailable state.
@NotNull PriceUpdateTradeEvent	createPriceUpdateTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the PriceUpdate state.
@NotNull PriceUpdateTradeEvent	createPriceUpdateTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the PriceUpdate state.
@NotNull QuoteAckTradeEvent	createQuoteAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the QuoteAck state.
@NotNull RejectAckTradeEvent	createRejectAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the RejectAck state.
@NotNull TradeConfirmedTradeEvent	createTradeConfirmedTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the TradeConfirmed state.
@NotNull TradeConfirmedTradeEvent	createTradeConfirmedTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the TradeConfirmed state.
@NotNull WithdrawAckTradeEvent	createWithdrawAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the WithdrawAck state.
void	sendClientRejectEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the ClientReject state.
void	sendClientRejectEvent(@NotNull ClientRejectTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the ClientReject state.
void	sendErrorEvent(@NotNull ErrorTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Error state.
void	sendHoldAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the HoldAck state.
void	sendHoldAckEvent(@NotNull HoldAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the HoldAck state.
void	sendPickUpAckEvent(@NotNull PickUpAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the PickUpAck state.
void	sendPickUpAckEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the PickUpAck state.
void	sendPickUpRejectedEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the PickUpRejected state.
void	sendPickUpRejectedEvent(@NotNull PickUpRejectedTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the PickUpRejected state.
void	sendPriceUnavailableEvent(@NotNull PriceUnavailableTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the PriceUnavailable state.
void	sendPriceUnavailableEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the PriceUnavailable state.
void	sendPriceUpdateEvent(@NotNull PriceUpdateTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the PriceUpdate state.
void	sendPriceUpdateEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the PriceUpdate state.
void	sendQuoteAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the QuoteAck state.
void	sendQuoteAckEvent(@NotNull QuoteAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the QuoteAck state.
void	sendRejectAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the RejectAck state.
void	sendRejectAckEvent(@NotNull RejectAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the RejectAck state.
void	sendTradeConfirmedEvent(@NotNull TradeConfirmedTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the TradeConfirmed state.
void	sendTradeConfirmedEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the TradeConfirmed state.
void	sendWithdrawAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the WithdrawAck state.
void	sendWithdrawAckEvent(@NotNull WithdrawAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the WithdrawAck 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

SalesInterventionTrade

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

createPickUpAckTradeEvent

@NotNull
public @NotNull PickUpAckTradeEvent createPickUpAckTradeEvent()

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

Returns:

A new instance of PickUpAckTradeEvent.

sendPickUpAckEvent

public void sendPickUpAckEvent(@NotNull
                               @NotNull PickUpAckTradeEvent event)

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

Parameters:

event - The event to send.

sendPickUpAckEvent

public void sendPickUpAckEvent(@NotNull
                               @NotNull Message message)

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

Parameters:

message - The message to send.

createPickUpAckTradeEvent

@NotNull
public @NotNull PickUpAckTradeEvent createPickUpAckTradeEvent(@NotNull
                                                              @NotNull Message message)

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

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of PickUpAckTradeEvent.

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.

createPickUpRejectedTradeEvent

@NotNull
public @NotNull PickUpRejectedTradeEvent createPickUpRejectedTradeEvent()

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

Returns:

A new instance of PickUpRejectedTradeEvent.

sendPickUpRejectedEvent

public void sendPickUpRejectedEvent(@NotNull
                                    @NotNull PickUpRejectedTradeEvent event)

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

Parameters:

event - The event to send.

sendPickUpRejectedEvent

public void sendPickUpRejectedEvent()

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

createRejectAckTradeEvent

@NotNull
public @NotNull RejectAckTradeEvent createRejectAckTradeEvent()

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

Returns:

A new instance of RejectAckTradeEvent.

sendRejectAckEvent

public void sendRejectAckEvent(@NotNull
                               @NotNull RejectAckTradeEvent event)

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

Parameters:

event - The event to send.

sendRejectAckEvent

public void sendRejectAckEvent()

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

createHoldAckTradeEvent

@NotNull
public @NotNull HoldAckTradeEvent createHoldAckTradeEvent()

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

Returns:

A new instance of HoldAckTradeEvent.

sendHoldAckEvent

public void sendHoldAckEvent(@NotNull
                             @NotNull HoldAckTradeEvent event)

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

Parameters:

event - The event to send.

sendHoldAckEvent

public void sendHoldAckEvent()

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

createPriceUnavailableTradeEvent

@NotNull
public @NotNull PriceUnavailableTradeEvent createPriceUnavailableTradeEvent()

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

Returns:

A new instance of PriceUnavailableTradeEvent.

sendPriceUnavailableEvent

public void sendPriceUnavailableEvent(@NotNull
                                      @NotNull PriceUnavailableTradeEvent event)

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

Parameters:

event - The event to send.

sendPriceUnavailableEvent

public void sendPriceUnavailableEvent(@NotNull
                                      @NotNull Message message)

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

Parameters:

message - The message to send.

createPriceUnavailableTradeEvent

@NotNull
public @NotNull PriceUnavailableTradeEvent createPriceUnavailableTradeEvent(@NotNull
                                                                            @NotNull Message message)

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

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of PriceUnavailableTradeEvent.

createPriceUpdateTradeEvent

@NotNull
public @NotNull PriceUpdateTradeEvent createPriceUpdateTradeEvent()

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

Returns:

A new instance of PriceUpdateTradeEvent.

sendPriceUpdateEvent

public void sendPriceUpdateEvent(@NotNull
                                 @NotNull PriceUpdateTradeEvent event)

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

Parameters:

event - The event to send.

sendPriceUpdateEvent

public void sendPriceUpdateEvent(@NotNull
                                 @NotNull Message message)

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

Parameters:

message - The message to send.

createPriceUpdateTradeEvent

@NotNull
public @NotNull PriceUpdateTradeEvent createPriceUpdateTradeEvent(@NotNull
                                                                  @NotNull Message message)

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

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of PriceUpdateTradeEvent.

createClientRejectTradeEvent

@NotNull
public @NotNull ClientRejectTradeEvent createClientRejectTradeEvent()

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

Returns:

A new instance of ClientRejectTradeEvent.

sendClientRejectEvent

public void sendClientRejectEvent(@NotNull
                                  @NotNull ClientRejectTradeEvent event)

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

Parameters:

event - The event to send.

sendClientRejectEvent

public void sendClientRejectEvent()

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

createTradeConfirmedTradeEvent

@NotNull
public @NotNull TradeConfirmedTradeEvent createTradeConfirmedTradeEvent()

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

Returns:

A new instance of TradeConfirmedTradeEvent.

sendTradeConfirmedEvent

public void sendTradeConfirmedEvent(@NotNull
                                    @NotNull TradeConfirmedTradeEvent event)

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

Parameters:

event - The event to send.

sendTradeConfirmedEvent

public void sendTradeConfirmedEvent(@NotNull
                                    @NotNull Message message)

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

Parameters:

message - The message to send.

createTradeConfirmedTradeEvent

@NotNull
public @NotNull TradeConfirmedTradeEvent createTradeConfirmedTradeEvent(@NotNull
                                                                        @NotNull Message message)

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

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of TradeConfirmedTradeEvent.

createWithdrawAckTradeEvent

@NotNull
public @NotNull WithdrawAckTradeEvent createWithdrawAckTradeEvent()

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

Returns:

A new instance of WithdrawAckTradeEvent.

sendWithdrawAckEvent

public void sendWithdrawAckEvent(@NotNull
                                 @NotNull WithdrawAckTradeEvent event)

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

Parameters:

event - The event to send.

sendWithdrawAckEvent

public void sendWithdrawAckEvent()

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

createQuoteAckTradeEvent

@NotNull
public @NotNull QuoteAckTradeEvent createQuoteAckTradeEvent()

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

Returns:

A new instance of QuoteAckTradeEvent.

sendQuoteAckEvent

public void sendQuoteAckEvent(@NotNull
                              @NotNull QuoteAckTradeEvent event)

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

Parameters:

event - The event to send.

sendQuoteAckEvent

public void sendQuoteAckEvent()

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