com.ibm.commerce.messaging.databeans
Class MsgObjectDataBean

java.lang.Object
  |
  +--MessagingDataBean
        |
        +--com.ibm.commerce.messaging.databeans.MsgObjectDataBean

public class MsgObjectDataBean
extends MessagingDataBean

MsgObjectDataBean, data bean used to encapsulate a messaging object

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
MsgObjectDataBean()
          Constructor for MsgObjectDataBean.
 
Method Summary
 java.lang.String getMsgConfigData(java.lang.String key)
          Returns the config data given the input key.
 java.lang.String getMsgContent()
          Returns the message content for the messaging object and default language encoding.
 java.lang.String getMsgContent(java.lang.String language)
          Returns the message content for the messaging object and language.
  Messaging getMsgObject()
          Returns the messaging object.
 java.lang.Integer getRetries()
          Returns the retires field for the messaging object.
 void populate()
          Retrieves and build a messaging object from either the MSGARCHIVE or the MSGSTORE table.
 void setMode(java.lang.Integer newMode)
          Sets the mode identifying the table to be retrieved.
 void setMsgId(java.lang.Long newMsgId)
          Sets the msg id for the desired messaging object to be retrieved.
 void setTransportId(java.lang.Integer newTranId)
          Sets the transport id for the desired messaging object to be retrieved.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values
Constructor Detail

MsgObjectDataBean

public MsgObjectDataBean()
Constructor for MsgObjectDataBean.
Method Detail

setMsgId

public void setMsgId(java.lang.Long newMsgId)
Sets the msg id for the desired messaging object to be retrieved.

setTransportId

public void setTransportId(java.lang.Integer newTranId)
Sets the transport id for the desired messaging object to be retrieved.

setMode

public void setMode(java.lang.Integer newMode)
Sets the mode identifying the table to be retrieved. 0=MSGARCHIVE,

1=MSGSTORE

Parameters:
newMode - the mode

getMsgConfigData

public java.lang.String getMsgConfigData(java.lang.String key)
Returns the config data given the input key.
Parameters:
key - the key to look up the configuration value
Returns:
configuration data from either the Connection spec or Interaction Spec

getMsgContent

public java.lang.String getMsgContent()
Returns the message content for the messaging object and default language encoding.
Returns:
the content in String format

getMsgContent

public java.lang.String getMsgContent(java.lang.String language)
Returns the message content for the messaging object and language. The return content string is in UTF8 format.
Returns:
the content in String format

getRetries

public java.lang.Integer getRetries()
Returns the retires field for the messaging object.
Returns:
the number of retries

getMsgObject

public Messaging getMsgObject()
Returns the messaging object.
Returns:
the messaging object

populate

public void populate()
              throws java.lang.Exception
Retrieves and build a messaging object from either the MSGARCHIVE or the MSGSTORE table.
Throws:
java.lang.Exception - Raised by all sub populate methods.