com.ibm.commerce.messaging.databeans

Class MsgObjectDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, java.io.Serializable


    public class MsgObjectDataBean
    extends com.ibm.commerce.messaging.databeans.MessagingDataBean
    MsgObjectDataBean, data bean used to encapsulate a messaging object.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

      • MsgObjectDataBean

        public MsgObjectDataBean()
        The constructor for MsgObjectDataBean calls its parents constructor.
    • Method Detail

      • setMsgId

        public void setMsgId(java.lang.Long newMsgId)
        This method sets the message ID for the desired messaging object to retrieve.
        Parameters:
        the - message ID for the command to use
      • setTransportId

        public void setTransportId(java.lang.Integer newTranId)
        This method sets the transport ID for the desired messaging object to retrieve.
        Parameters:
        the - transport ID for the command to use
      • setMode

        public void setMode(java.lang.Integer newMode)
        This method sets the mode identifying the table to retrieve. 0=MSGARCHIVE,

        1=MSGSTORE

        Parameters:
        newMode - the mode
      • getMsgConfigData

        public java.lang.String getMsgConfigData(java.lang.String key)
        This method returns the configuration 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()
        This method 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)
        This method returns the message content for the messaging object and language. The return content string is in UTF-8 format.
        Parameters:
        langauage - The language used during content creation.
        Returns:
        the content in String format
      • getRetries

        public java.lang.Integer getRetries()
        This method returns the retries value for the messaging object.
        Returns:
        the number of retries
      • getMsgObject

        public Messaging getMsgObject()
        This method returns the messaging object.
        Returns:
        the messaging object
      • populate

        public void populate()
                      throws java.lang.Exception
        This method retrieves and builds a messaging object from either the MSGARCHIVE or the MSGSTORE table.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception - Raised by all sub populate methods.