|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fxcm.fix.admin.Heartbeat
public class Heartbeat
Heartbeat, FIX 4-3.
| Field Summary | |
|---|---|
static com.fxcm.entity.ICode |
OBJ_TYPE
HeartBeat object type |
| Constructor Summary | |
|---|---|
Heartbeat()
Creates object with default state. |
|
Heartbeat(String aTestReqID)
Creates object with given state values. |
|
| Method Summary | |
|---|---|
boolean |
fill(IMessage aMsg)
Fills object state based on message state. |
long |
getMakingTime()
Return the time when this instance of ITransportable object was made |
String |
getRequestID()
Obtains the Request ID on this object |
String |
getTestReqID()
Obtains test request ID. |
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()
Determines whether object state is valid. |
void |
reset()
Reset object state to default values. |
void |
setTestReqID(String aTestReqID)
Updates Test Request ID. |
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 Heartbeat()
public Heartbeat(String aTestReqID)
aTestReqID - The ID of previous Test Request| Method Detail |
|---|
public com.fxcm.entity.ICode getType()
getType in interface ITransportablepublic void setTestReqID(String aTestReqID)
null by default.
aTestReqID - The ID of previous Test Requestpublic String getTestReqID()
null if not present
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 void reset()
public boolean fill(IMessage aMsg)
fill in interface ITransportableaMsg - message
true if new state is OK; false otherwise.public boolean update(IMessage aMsg)
fill().
update in interface ITransportableaMsg - message
true if new state is OK; false otherwise.public boolean isValid()
isValid in interface ITransportabletrue alwais.public String getRequestID()
ITransportable
getRequestID in interface ITransportablepublic String getTradingSessionID()
ITransportable
getTradingSessionID in interface ITransportablepublic String getTradingSessionSubID()
ITransportable
getTradingSessionSubID in interface ITransportablepublic String toString()
toString in class Objectpublic long getMakingTime()
getMakingTime in interface ITransportable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||