com.caplin.motif.fx.trading.orders.bulkaction

Class BulkOrderActionTrade

java.lang.Object

com.caplin.motif.trading.MotifTrade

com.caplin.motif.fx.trading.orders.bulkaction.BulkOrderActionTrade

public class BulkOrderActionTrade
extends MotifTrade

An instance of this object represents a request from the client to perform an action on a number of orders.

Field Summary

Fields inherited from class com.caplin.motif.trading.MotifTrade

trade

Constructor Summary

Constructors

Constructor and Description
BulkOrderActionTrade(com.caplin.trading.Trade trade, BulkOrderAction bulkOrderAction, Set<String> orderIDs) Constructs the BulkOrderActionTrade with a trade object from the underlying trading datasource that contains the fields and the state model representing the clients request to perform bulk action on a set of orders.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
BulkOrderActionSentResponder	getBulkActionSentResponder() Returns the responder that can trigger events from the BulkActionSent state.
BulkOrderAction	getBulkOrderAction()
Set<String>	getOrderIDs() The ids of the orders on which this action should be performed on.
BulkOrderActionProcessingResponder	getProcessingResponder() Returns the responder that can trigger events from the Processing state.
int	hashCode()
String	toString()

Methods inherited from class com.caplin.motif.trading.MotifTrade

getCurrentState, getField, getRequestID, getTradeChannelSubject, getUsername

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BulkOrderActionTrade

public BulkOrderActionTrade(com.caplin.trading.Trade trade,
                    BulkOrderAction bulkOrderAction,
                    Set<String> orderIDs)

Constructs the BulkOrderActionTrade with a trade object from the underlying trading datasource that contains the fields and the state model representing the clients request to perform bulk action on a set of orders.

Note: As a user of the FXIntegrationAPI one is not expected to create this object, but to be passed these in listeners. See BulkOrderActionTradeListener

Parameters:

trade - The underlying trade from the trading datasource library.

orderIDs - A set of order ids on which the bulk order action BulkOrderAction will be performed.

bulkOrderAction - The bulk action to perform on these orders.

Method Detail

getBulkActionSentResponder

public BulkOrderActionSentResponder getBulkActionSentResponder()

Returns the responder that can trigger events from the BulkActionSent state.

Returns:

the responder that can trigger events from the BulkActionSent state.

getProcessingResponder

public BulkOrderActionProcessingResponder getProcessingResponder()

Returns the responder that can trigger events from the Processing state.

Returns:

the responder that can trigger events from the Processing state.

getBulkOrderAction

public BulkOrderAction getBulkOrderAction()

Returns:

the BulkOrderAction for this trade

getOrderIDs

public Set<String> getOrderIDs()

The ids of the orders on which this action should be performed on.

Returns:

the id of the orders that this action will be performed on.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class MotifTrade