|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fxcm.fix.trade.OrderCancelReject
public class OrderCancelReject
The order cancel reject message is issued by the broker upon receipt of a cancel request or cancel/replace request message which cannot be honored. The execution message responds to accepted cancel request and cancel/replace request messages.
| Field Summary | |
|---|---|
static com.fxcm.entity.ICode |
OBJ_TYPE
|
| Constructor Summary | |
|---|---|
OrderCancelReject()
|
|
| Method Summary | |
|---|---|
boolean |
fill(IMessage aMsg)
Fills object state based on message. |
String |
getAccount()
Retrieve account id for this transaction. |
String |
getClOrdID()
Retrieve order request id. |
ICxlRejReason |
getCxlRejReason()
Obtains the Code to identify reason for cancel rejection from a OrderCancelReplaceRequest or OrderCancelRequest |
ICxlRejResponseTo |
getCxlRejResponseTo()
Obtains the type of request that a Cancel Reject is in response to. |
String |
getFXCMErrorDetails()
Obtains the FXCM Error Details, This text contains any error information from the request directly from the FXCM System. |
int |
getFXCMRequestRejectReason()
Obtains the FXCM Request Reject Reason, this is a FXCM specific reject code. |
long |
getMakingTime()
Return the time when this instance of ITransportable object was made |
String |
getOrderID()
|
IOrdStatus |
getOrdStatus()
Obtains the Order Status Code, this code is a representation of the order's curent status in our system |
String |
getOrigClOrdID()
Obtains the original client order id |
String |
getRequestID()
Obtains the Request ID on this object |
String |
getSecondaryClOrdID()
get the custom text |
String |
getText()
Obtains the text, this can contain any additional text on this message |
String |
getTradingSessionID()
Obtains current Trading Session ID. |
String |
getTradingSessionSubID()
Obtains current Trading Session sub ID. |
UTCTimestamp |
getTransactTime()
Obtains time of transaction. |
com.fxcm.entity.ICode |
getType()
Obtains object type. |
boolean |
isValid()
Validates object state. |
void |
setAccount(String account)
Set the account id for this transaction. |
void |
setClOrdID(String clOrdID)
Set the order request id, as specified by the client. |
void |
setCxlRejReason(ICxlRejReason aCxlRejReason)
Sets the Code to identify reason for cancel rejection from a OrderCancelReplaceRequest or OrderCancelRequest |
void |
setCxlRejResponseTo(ICxlRejResponseTo aCxlRejResponseTo)
Sets the type of request that a Cancel Reject is in response to. |
void |
setFXCMErrorDetails(String aFXCMErrorDetails)
Sets the FXCM Error details, use this to store error informatino from the FXCM System |
void |
setFXCMRequestRejectReason(int aFXCMRequestRejectReason)
Sets the FXCM Request Reject Reason Code |
void |
setOrderID(String aOrderID)
|
void |
setOrdStatus(IOrdStatus aOrdStatus)
Sets the Order Status a representation of the order's curent status in our system |
void |
setOrigClOrdID(String aOrigClOrdID)
Sets the original client order id |
void |
setSecondaryClOrdID(String mSecondaryClOrdID)
set the custom text |
void |
setText(String aText)
Sets the text, this can contain any additional text on this message |
void |
setTradingSessionID(String aTradingSessionID)
Updates Trading Session ID. |
void |
setTradingSessionSubID(String aTradingSessionSubID)
Updates Trading Session sub ID. |
void |
setTransactTime(UTCTimestamp aTransactTime)
Updates snapshot time. |
IMessage |
toMessage(String aSID,
IMessageFactory aFactory)
Converts object to message. |
IMessage |
toMessage(String aSID,
String aTradingSessionID,
String aTradingSessionSubID,
String aRequestID,
int aOptions,
IMessageFactory aFactory)
Converts object to IMessage. |
String |
toString()
|
boolean |
update(IMessage aMsg)
Update object state based on message state. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final com.fxcm.entity.ICode OBJ_TYPE
| Constructor Detail |
|---|
public OrderCancelReject()
| Method Detail |
|---|
public boolean fill(IMessage aMsg)
ITransportable
fill in interface ITransportableaMsg - message to get new state from
true if succeeded, false otherwise.public String getAccount()
public void setAccount(String account)
public void setOrderID(String aOrderID)
public String getOrderID()
public String getClOrdID()
public void setClOrdID(String clOrdID)
public String getSecondaryClOrdID()
public void setSecondaryClOrdID(String mSecondaryClOrdID)
mSecondaryClOrdID - public void setTradingSessionID(String aTradingSessionID)
public void setTradingSessionSubID(String aTradingSessionSubID)
public String getTradingSessionID()
getTradingSessionID in interface ITransportablenull when not present.public String getTradingSessionSubID()
getTradingSessionSubID in interface ITransportablenull when not present.public UTCTimestamp getTransactTime()
nullpublic void setTransactTime(UTCTimestamp aTransactTime)
"00:00:00" by default.
public ICxlRejReason getCxlRejReason()
OrderCancelReplaceRequest or OrderCancelRequest
CxlRejReasonFactorypublic void setCxlRejReason(ICxlRejReason aCxlRejReason)
OrderCancelReplaceRequest or OrderCancelRequest
aCxlRejReason - one of values from CxlRejReasonFactorypublic ICxlRejResponseTo getCxlRejResponseTo()
CxlRejResponseToFactorypublic void setCxlRejResponseTo(ICxlRejResponseTo aCxlRejResponseTo)
aCxlRejResponseTo - one of the values from CxlRejResponseToFactorypublic String getFXCMErrorDetails()
public void setFXCMErrorDetails(String aFXCMErrorDetails)
aFXCMErrorDetails - public int getFXCMRequestRejectReason()
FXCMREQUESTREJECTREASON_*public void setFXCMRequestRejectReason(int aFXCMRequestRejectReason)
aFXCMRequestRejectReason - One of the values from FXCMREQUESTREJECTREASON_*public IOrdStatus getOrdStatus()
OrdStatusFactorypublic void setOrdStatus(IOrdStatus aOrdStatus)
aOrdStatus - One of the values from OrdStatusFactorypublic String getOrigClOrdID()
public void setOrigClOrdID(String aOrigClOrdID)
aOrigClOrdID - public String getRequestID()
ITransportable
getRequestID in interface ITransportablepublic String getText()
public void setText(String aText)
aText - public com.fxcm.entity.ICode getType()
ITransportable
getType in interface ITransportablepublic boolean isValid()
ITransportable
isValid in interface ITransportabletrue if object state is valid, false otherwise.
public IMessage toMessage(String aSID,
IMessageFactory aFactory)
toMessage in interface ITransportableaSID - User session IDaFactory - message factory to create message objects
null in case of errors
public IMessage toMessage(String aSID,
String aTradingSessionID,
String aTradingSessionSubID,
String aRequestID,
int aOptions,
IMessageFactory aFactory)
toMessage in interface ITransportableaSID - user session IDaTradingSessionID - Trading Session ID, to alternate a value from object stateaTradingSessionSubID - Trading Session Sub ID, to alternate a value from object stateaRequestID - Request ID, to alternate a value from object stateaOptions - Set of options for message creation, reservedaFactory - message factory that is in use to process
null if creation failspublic String toString()
toString in class Objectpublic boolean update(IMessage aMsg)
update in interface ITransportableaMsg - message to get udpated state from
true if new state is OK; false otherwise.public long getMakingTime()
getMakingTime in interface ITransportable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||