Package com.caplin.motif.fx.trading.block

Class BlockTrade

java.lang.Object
com.caplin.motif.UserTrade
com.caplin.motif.fx.trading.block.BlockTrade
public class BlockTrade extends UserTrade

A BlockTrade is a domain object that represents a block trade. These trades are generally executed from a block trading screen that allows trades to be submitted in bulk.

You do not need to construct instances of this class yourself. Instances of this class are created by the FX Integration API in response to block trade requests from the client, and passed to your implementation of BlockTradeListenerFactory.createBlockTradeListener(BlockTrade).

  • Method Details

    • getInputTrades

      public List<BlockTradeExecution> getInputTrades()
      Returns the list of underlying input trades that make up the block trade. Does not include the netted trades.
      Returns:
      The list of underlying input trades.
      See Also:

    • getNettedTrades

      public List<BlockTradeExecution> getNettedTrades()
      Returns the list of underlying netted trades that make up the block trade. Does not include the client trades.
      Returns:
      The list of underlying netted trades.
      See Also:

    • getTrades

      public List<BlockTradeExecution> getTrades()
      Returns the list of underlying BlockTradeExecution that make up the block trade.
      Returns:
      The list of underlying trades.
      See Also:

    • getSubmittedResponder

      public BlockTradeSubmittedResponder getSubmittedResponder()
      Returns the responder that can send messages from the Submitted state
      Returns:
      The responder for the Submitted state

    • getClientCloseSentResponder

      public BlockTradeClientCloseSentResponder getClientCloseSentResponder()
      Returns the responder that can send messages from the ClientCloseSent state
      Returns:
      The responder for the ClientCloseSent state.

    • getExecutedResponder

      public BlockTradeExecutedResponder getExecutedResponder()
      Returns the responder that can send messages from the Submitted state
      Returns:
      The responder for the Submitted state

    • getExecutedSentResponder

      public BlockTradeExecuteSentResponder getExecutedSentResponder()
      Returns the responder that can send messages from the ExecuteSent state
      Returns:
      The responder for the ExecuteSent state

    • getExecutableResponder

      public BlockTradeExecutableResponder getExecutableResponder()
      Returns the responder that can send messages from the Executable state
      Returns:
      The responder for the Executable state

    • getPickedUpResponder

      public BlockTradePickedUpResponder getPickedUpResponder()
      Returns the picked up responder
      Returns:
      the picked up responder

    • getQueuedResponder

      public BlockTradeQueuedResponder getQueuedResponder()
      Returns the queued responder
      Returns:
      the queued responder

    • getTradingProtocol

      public String getTradingProtocol()
      Returns the trading protocol
      Returns:
      the trading protocol

    • toString

      public String toString()
      Returns the BlockTrade as a String
      Overrides:
      toString in class UserTrade
      Returns:
      the String representing the BlockTrade