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

Class BulkOrderActionTrade

java.lang.Object

com.caplin.motif.UserTrade

com.caplin.generated.motif.fx.orders.bulkorderaction.BulkOrderActionTrade

public class BulkOrderActionTrade
extends UserTrade

A single BulkOrderActionTrade 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
BulkOrderActionTrade(@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 BulkActionAckTradeEvent	createBulkActionAckTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the BulkActionAck state.
@NotNull BulkActionCompletedTradeEvent	createBulkActionCompletedTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the BulkActionCompleted state.
@NotNull ErrorTradeEvent	createErrorTradeEvent()	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
@NotNull ErrorTradeEvent	createErrorTradeEvent(@NotNull Message message)	Create a TradeEvent that can be used to trigger the trade to transition into the Error state.
void	sendBulkActionAckEvent()	Send a TradeEvent with no fields to trigger the trade to transition into the BulkActionAck state.
void	sendBulkActionAckEvent(@NotNull BulkActionAckTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the BulkActionAck state.
void	sendBulkActionCompletedEvent(@NotNull BulkActionCompletedTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the BulkActionCompleted state.
void	sendErrorEvent(@NotNull ErrorTradeEvent event)	Send a TradeEvent to trigger the trade to transition into the Error state.
void	sendErrorEvent(@NotNull Message message)	Send a TradeEvent to trigger the trade to transition into the Error 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

BulkOrderActionTrade

public BulkOrderActionTrade(@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 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(@NotNull
                           @NotNull Message message)

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

Parameters:

message - The message to send.

createErrorTradeEvent

@NotNull
public @NotNull ErrorTradeEvent createErrorTradeEvent(@NotNull
                                                      @NotNull Message message)

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

Parameters:

message - a Message to be passed to the TradeEvent

Returns:

A new instance of ErrorTradeEvent.

createBulkActionAckTradeEvent

@NotNull
public @NotNull BulkActionAckTradeEvent createBulkActionAckTradeEvent()

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

Returns:

A new instance of BulkActionAckTradeEvent.

sendBulkActionAckEvent

public void sendBulkActionAckEvent(@NotNull
                                   @NotNull BulkActionAckTradeEvent event)

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

Parameters:

event - The event to send.

sendBulkActionAckEvent

public void sendBulkActionAckEvent()

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

createBulkActionCompletedTradeEvent

@NotNull
public @NotNull BulkActionCompletedTradeEvent createBulkActionCompletedTradeEvent()

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

Returns:

A new instance of BulkActionCompletedTradeEvent.

sendBulkActionCompletedEvent

public void sendBulkActionCompletedEvent(@NotNull
                                         @NotNull BulkActionCompletedTradeEvent event)

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

Parameters:

event - The event to send.