com.caplin.motif.fx.trading.orders.activestatechange

Class ChangeActiveState

java.lang.Object

com.caplin.motif.trading.MotifTrade

com.caplin.motif.fx.trading.orders.activestatechange.ChangeActiveState

public class ChangeActiveState
extends MotifTrade

An instance of this object represents a request from the client to change the state of an existing order.

Field Summary

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

trade

Constructor Summary

Constructors

Constructor and Description
ChangeActiveState(com.caplin.trading.Trade trade, String parentOrderID, String orderID, ActiveState newState) Constructs the ChangeActiveState with a trade object from the underlying trading datasource that contains the fields and the state model representing the clients request to change the state of an already existing order.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
OrderChangeStateSentResponder	getChangeStateSentResponder() Returns the responder that can trigger events from the ChangeStateSent state.
OrderChangingStateResponder	getChangingStateResponder() Returns the responder that can trigger events from the ChangingState state.
ActiveState	getNewState() Returns an instance of ActiveState which represents the new state that the client wants the order to change to.
String	getOrderID() The id of the order that client wants to change the state of
String	getParentOrderID() ParentOrderID is optional and might be not defined
int	hashCode()

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

createEvent, getCurrentState, getField, getRequestID, getTradeChannelSubject, getUsername, sendEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeActiveState

public ChangeActiveState(com.caplin.trading.Trade trade,
                         String parentOrderID,
                         String orderID,
                         ActiveState newState)

Constructs the ChangeActiveState with a trade object from the underlying trading datasource that contains the fields and the state model representing the clients request to change the state of an already existing order.

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

Parameters:

trade - The underlying trade from the trading datasource library.

parentOrderID - The ID of the parent order if the order to be changed is part of a multi-leg order.

orderID - The ID of the order that client wants to change the state of.

newState - The new state that the client wants to change the order to.

Method Detail

getChangeStateSentResponder

public OrderChangeStateSentResponder getChangeStateSentResponder()

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

Returns:

the responder that can trigger events from the ChangeStateSent state.

getChangingStateResponder

public OrderChangingStateResponder getChangingStateResponder()

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

Returns:

the responder that can trigger events from the ChangingState state.

getParentOrderID

public String getParentOrderID()

ParentOrderID is optional and might be not defined

Returns:

parentOrderId or null (if parentOrderId is not defined)

getOrderID

public String getOrderID()

The id of the order that client wants to change the state of

Returns:

the id of the order that the client wants to change the state of

getNewState

public ActiveState getNewState()

Returns an instance of ActiveState which represents the new state that the client wants the order to change to.

Returns:

the new state that the order should change to.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object