|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fxcm.fix.admin.Logout
public class Logout
The Logout (5) message initiates or confirms the termination of a session.
| Field Summary | |
|---|---|
static com.fxcm.entity.ICode |
OBJ_TYPE
Logout object type |
| Constructor Summary | |
|---|---|
Logout()
|
|
Logout(String aText)
|
|
| Method Summary | |
|---|---|
boolean |
fill(IMessage aMsg)
Fills object state based on message. |
long |
getMakingTime()
Return the time when this instance of ITransportable object was made |
String |
getRequestID()
Obtains the Request ID on this object |
String |
getText()
Free format text string |
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 |
setText(String aText)
Free format text string |
IMessage |
toMessage(String aSID,
IMessageFactory aFactory)
Converts object to IMessage. |
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 Logout()
public Logout(String aText)
| 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 getRequestID()
ITransportable
getRequestID in interface ITransportablepublic String getText()
public void setText(String aText)
aText - public String getTradingSessionID()
ITransportable
getTradingSessionID in interface ITransportablepublic String getTradingSessionSubID()
ITransportable
getTradingSessionSubID in interface ITransportablepublic 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)
ITransportable
toMessage in interface ITransportableaSID - user session IDaFactory - message factory that is in use to process
null if creation fails
public IMessage toMessage(String aSID,
String aTradingSessionID,
String aTradingSessionSubID,
String aRequestID,
int aOptions,
IMessageFactory aFactory)
ITransportable
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 | |||||||||