|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fxcm.fix.pretrade.EMail
public class EMail
The email message is similar to the format and purpose of the News message, however, it is intended for private use between two parties. FXCM will use this message type to port FXCM mail messages
| Field Summary | |
|---|---|
static com.fxcm.entity.ICode |
OBJ_TYPE
|
| Constructor Summary | |
|---|---|
EMail()
|
|
| Method Summary | |
|---|---|
boolean |
fill(IMessage aMsg)
Fills object state based on message. |
String |
getEmailThreadID()
|
String |
getFrom()
|
long |
getMakingTime()
Return the time when this instance of ITransportable object was made |
UTCTimestamp |
getOrigTime()
|
String |
getRequestID()
Obtains the Request ID on this object |
String |
getSubject()
|
String |
getText()
Repeating field, number of instances defined in LinesOfText |
String |
getTradingSessionID()
Obtains the Trading Session ID |
String |
getTradingSessionSubID()
Obtains the Trading Session Sub ID |
com.fxcm.entity.ICode |
getType()
Obtains object type. |
boolean |
isValid()
Validates object state. |
void |
reset()
|
void |
setEmailThreadID(String aThreadID)
|
void |
setFrom(String aFrom)
|
void |
setOrigTime(UTCTimestamp aOrigTime)
|
void |
setSubject(String aSubject)
|
void |
setText(String aText)
|
void |
setTradingSessionID(String aTradingSessionID)
|
void |
setTradingSessionSubID(String aTradingSessionSubID)
|
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)
Updates object state based on message. |
| 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 EMail()
| 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 getEmailThreadID()
public void setEmailThreadID(String aThreadID)
public String getFrom()
public void setFrom(String aFrom)
public UTCTimestamp getOrigTime()
public void setOrigTime(UTCTimestamp aOrigTime)
public String getRequestID()
ITransportable
getRequestID in interface ITransportablepublic String getSubject()
public void setSubject(String aSubject)
public String getText()
public void setText(String aText)
public String getTradingSessionID()
ITransportable
getTradingSessionID in interface ITransportablepublic void setTradingSessionID(String aTradingSessionID)
public String getTradingSessionSubID()
ITransportable
getTradingSessionSubID in interface ITransportablepublic void setTradingSessionSubID(String aTradingSessionSubID)
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 void reset()
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)
ITransportable
update in interface ITransportableaMsg - message to get udpated state from
true if succeeded, 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 | |||||||||