com.fxcm.messaging
Class TransportableContainer

java.lang.Object
  com.fxcm.messaging.TransportableContainer

All Implemented Interfaces:

ITransportable

public class TransportableContainer
extends Object
implements ITransportable

Field Summary

static com.fxcm.entity.ICode

OBJ_TYPE

Constructor Summary

TransportableContainer(ITransportable aObject, String aTradingSessionID, String aTradingSessionSubID, String aRequestID, int aOptions)

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
int	getOptions()
String	getRequestID() Obtains the Request ID on this object
String	getTradingSessionID() Obtains the Trading Session ID
String	getTradingSessionSubID() Obtains the Trading Session Sub ID
ITransportable	getTransportable()
com.fxcm.entity.ICode	getType() Obtains object type.
boolean	isValid() Validates object state.
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.
boolean	update(IMessage aMsg) Updates object state based on message.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJ_TYPE

public static final com.fxcm.entity.ICode OBJ_TYPE

Constructor Detail

TransportableContainer

public TransportableContainer(ITransportable aObject,
                              String aTradingSessionID,
                              String aTradingSessionSubID,
                              String aRequestID,
                              int aOptions)

Method Detail

toMessage

public IMessage toMessage(String aSID,
                          IMessageFactory aFactory)

Converts object to IMessage.

Specified by:

toMessage in interface ITransportable

Parameters:

aSID - user session ID

aFactory - message factory that is in use to process

Returns:

new messge create or null if creation fails

toMessage

public IMessage toMessage(String aSID,
                          String aTradingSessionID,
                          String aTradingSessionSubID,
                          String aRequestID,
                          int aOptions,
                          IMessageFactory aFactory)

Converts object to IMessage.

Specified by:

toMessage in interface ITransportable

Parameters:

aSID - user session ID

aTradingSessionID - Trading Session ID, to alternate a value from object state

aTradingSessionSubID - Trading Session Sub ID, to alternate a value from object state

aRequestID - Request ID, to alternate a value from object state

aOptions - Set of options for message creation, reserved

aFactory - message factory that is in use to process

Returns:

new messge create or null if creation fails

fill

public boolean fill(IMessage aMsg)

Fills object state based on message.

Specified by:

fill in interface ITransportable

Parameters:

aMsg - message to get new state from

Returns:

true if succeeded, false otherwise.

update

public boolean update(IMessage aMsg)

Updates object state based on message.

Specified by:

update in interface ITransportable

Parameters:

aMsg - message to get udpated state from

Returns:

true if succeeded, false otherwise.

isValid

public boolean isValid()

Validates object state.

Specified by:

isValid in interface ITransportable

Returns:

true if object state is valid, false otherwise.

getType

public com.fxcm.entity.ICode getType()

Obtains object type.

Specified by:

getType in interface ITransportable

Returns:

code of object type.

getTradingSessionID

public String getTradingSessionID()

Obtains the Trading Session ID

Specified by:

getTradingSessionID in interface ITransportable

getTradingSessionSubID

public String getTradingSessionSubID()

Obtains the Trading Session Sub ID

Specified by:

getTradingSessionSubID in interface ITransportable

getRequestID

public String getRequestID()

Obtains the Request ID on this object

Specified by:

getRequestID in interface ITransportable

getOptions

public int getOptions()

getTransportable

public ITransportable getTransportable()

getMakingTime

public long getMakingTime()

Return the time when this instance of ITransportable object was made

Specified by:

getMakingTime in interface ITransportable

Returns:

object making time