com.caplin.motif.fx.trading.orders.cancelation

Class CancelRequest

java.lang.Object

com.caplin.motif.trading.MotifTrade

com.caplin.motif.fx.trading.orders.cancelation.CancelRequest

public class CancelRequest
extends MotifTrade

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

Field Summary

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

trade

Constructor Summary

Constructors

Constructor and Description
CancelRequest(com.caplin.trading.Trade trade, String parentOrderID, String orderID) Constructs the CancelRequest with a trade object from the underying trading datasource that contains the fields and the state model representing the clients request to cancel an already existing order.

Method Summary

Methods

Modifier and Type	Method and Description
OrderCancelingResponder	getCancelingResponder() Returns the Responder for responding to events from the Canceling state
OrderCancelSentResponder	getCancelSentResponder() Returns the Responder for responding to events from the CancelSent state.
String	getOrderID() The ID of the order that is to be canceled, that the backend trading system understands.
String	getParentOrderID() ParentOrderID is optional and might be not defined

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

getCurrentState, getField, getRequestID, getTradeChannelSubject, getUsername, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CancelRequest

public CancelRequest(com.caplin.trading.Trade trade,
             String parentOrderID,
             String orderID)

Constructs the CancelRequest with a trade object from the underying trading datasource that contains the fields and the state model representing the clients request to cancel 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 OrderCancelationListener

Parameters:

trade - The underlying trade from the trading datasource library.

parentOrderID - The ID of the parent order if part of a multi-leg order.

orderID - The ID of the order that is to be canceled.

Method Detail

getCancelSentResponder

public OrderCancelSentResponder getCancelSentResponder()

Returns the Responder for responding to events from the CancelSent state. When the backend receives a request to cancel an order, the Responder should be used to send an acknowledgement of this and transition the state to Canceling.

Returns:

The responder for the CancelSent state

getCancelingResponder

public OrderCancelingResponder getCancelingResponder()

Returns the Responder for responding to events from the Canceling state

Returns:

The responder for the Canceling 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 is to be canceled, that the backend trading system understands.

Returns:

The order ID