public class AllocateTrade extends UserTrade
A single AllocateTrade 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 and Description |
---|
AllocateTrade(@NotNull com.caplin.trading.Trade backingTrade,
@NotNull ScheduledExecutorService executorService)
Constructor used by the generated code.
|
Modifier and Type | Method and Description |
---|---|
@NotNull AllocateAckTradeEvent |
createAllocateAckTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the AllocateAck state. |
@NotNull AllocateAckTradeEvent |
createAllocateAckTradeEvent(@NotNull Message message)
Create a
TradeEvent that can be used to trigger the trade to transition into the AllocateAck state. |
@NotNull ClientCloseAckTradeEvent |
createClientCloseAckTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the ClientCloseAck state. |
@NotNull DetailsUpdateTradeEvent |
createDetailsUpdateTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the DetailsUpdate state. |
@NotNull DetailsUpdateTradeEvent |
createDetailsUpdateTradeEvent(@NotNull Message message)
Create a
TradeEvent that can be used to trigger the trade to transition into the DetailsUpdate state. |
@NotNull ErrorTradeEvent |
createErrorTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the Error state. |
@NotNull HoldTradeEvent |
createHoldTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the Hold state. |
@NotNull RejectTradeEvent |
createRejectTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the Reject state. |
@NotNull WithdrawTradeEvent |
createWithdrawTradeEvent()
Create a
TradeEvent that can be used to trigger the trade to transition into the Withdraw state. |
void |
sendAllocateAckEvent(@NotNull AllocateAckTradeEvent event)
Send a
TradeEvent to trigger the trade to transition into the AllocateAck state. |
void |
sendAllocateAckEvent(@NotNull Message message)
Send a
TradeEvent to trigger the trade to transition into the AllocateAck 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 |
sendDetailsUpdateEvent(@NotNull DetailsUpdateTradeEvent event)
Send a
TradeEvent to trigger the trade to transition into the DetailsUpdate state. |
void |
sendDetailsUpdateEvent(@NotNull Message message)
Send a
TradeEvent to trigger the trade to transition into the DetailsUpdate 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 |
sendHoldEvent()
Send a
TradeEvent with no fields to trigger the trade to transition into the Hold state. |
void |
sendHoldEvent(@NotNull HoldTradeEvent event)
Send a
TradeEvent to trigger the trade to transition into the Hold state. |
void |
sendRejectEvent()
Send a
TradeEvent with no fields to trigger the trade to transition into the Reject state. |
void |
sendRejectEvent(@NotNull RejectTradeEvent event)
Send a
TradeEvent to trigger the trade to transition into the Reject state. |
void |
sendWithdrawEvent()
Send a
TradeEvent with no fields to trigger the trade to transition into the Withdraw state. |
void |
sendWithdrawEvent(@NotNull WithdrawTradeEvent event)
Send a
TradeEvent to trigger the trade to transition into the Withdraw state. |
getBackingTrade, getExecutorService, getRequestID, getUsername, toString
public AllocateTrade(@NotNull @NotNull com.caplin.trading.Trade backingTrade, @NotNull @NotNull ScheduledExecutorService executorService)
Constructor used by the generated code.
@NotNull public @NotNull AllocateAckTradeEvent createAllocateAckTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the AllocateAck state.
public void sendAllocateAckEvent(@NotNull @NotNull AllocateAckTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the AllocateAck state.
event
- The event to send.public void sendAllocateAckEvent(@NotNull @NotNull Message message)
Send a TradeEvent
to trigger the trade to transition into the AllocateAck state.
message
- The message to send.@NotNull public @NotNull AllocateAckTradeEvent createAllocateAckTradeEvent(@NotNull @NotNull Message message)
Create a TradeEvent
that can be used to trigger the trade to transition into the AllocateAck state.
@NotNull public @NotNull RejectTradeEvent createRejectTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the Reject state.
public void sendRejectEvent(@NotNull @NotNull RejectTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the Reject state.
event
- The event to send.public void sendRejectEvent()
Send a TradeEvent
with no fields to trigger the trade to transition into the Reject state.
@NotNull public @NotNull ErrorTradeEvent createErrorTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the Error state.
public void sendErrorEvent(@NotNull @NotNull ErrorTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the Error state.
event
- The event to send.public void sendErrorEvent()
Send a TradeEvent
with no fields to trigger the trade to transition into the Error state.
@NotNull public @NotNull HoldTradeEvent createHoldTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the Hold state.
public void sendHoldEvent(@NotNull @NotNull HoldTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the Hold state.
event
- The event to send.public void sendHoldEvent()
Send a TradeEvent
with no fields to trigger the trade to transition into the Hold state.
@NotNull public @NotNull WithdrawTradeEvent createWithdrawTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the Withdraw state.
public void sendWithdrawEvent(@NotNull @NotNull WithdrawTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the Withdraw state.
event
- The event to send.public void sendWithdrawEvent()
Send a TradeEvent
with no fields to trigger the trade to transition into the Withdraw state.
@NotNull public @NotNull DetailsUpdateTradeEvent createDetailsUpdateTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the DetailsUpdate state.
public void sendDetailsUpdateEvent(@NotNull @NotNull DetailsUpdateTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the DetailsUpdate state.
event
- The event to send.public void sendDetailsUpdateEvent(@NotNull @NotNull Message message)
Send a TradeEvent
to trigger the trade to transition into the DetailsUpdate state.
message
- The message to send.@NotNull public @NotNull DetailsUpdateTradeEvent createDetailsUpdateTradeEvent(@NotNull @NotNull Message message)
Create a TradeEvent
that can be used to trigger the trade to transition into the DetailsUpdate state.
@NotNull public @NotNull ClientCloseAckTradeEvent createClientCloseAckTradeEvent()
Create a TradeEvent
that can be used to trigger the trade to transition into the ClientCloseAck state.
public void sendClientCloseAckEvent(@NotNull @NotNull ClientCloseAckTradeEvent event)
Send a TradeEvent
to trigger the trade to transition into the ClientCloseAck state.
event
- The event to send.public void sendClientCloseAckEvent()
Send a TradeEvent
with no fields to trigger the trade to transition into the ClientCloseAck state.
Copyright © 2018 Caplin Systems.