com.ibm.commerce.emarketing.beans

Class EmailConfigurationDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, java.io.Serializable


    public class EmailConfigurationDataBean
    extends EmailConfigurationDataBeanBase
    Used to lookup e-mail server configurations for the current store.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getInboundAccount()
      Gets the account name used to connect to the server.
      java.lang.String getInboundAddress()
      Gets the inbound e-mail address for bounced back mail.
      java.lang.String getInboundDescription()
      Gets the inbound e-mail description name.
      java.lang.String getInboundEmlServer()
      Gets the host name of the e-mail server.
      java.lang.String getInboundHost()
      Gets the host name of the server upon which to run the e-mail activity jobs.
      java.lang.Integer getInboundHour()
      Gets the hours of the time e-mail activity jobs will run.
      java.lang.Integer getInboundId()
      Gets the inbound e-mail configuration ID.
      java.lang.Integer getInboundMinute()
      Gets the minutes of the time e-mail activity jobs will run.
      java.lang.String getInboundName()
      Gets the inbound e-mail configuration name.
      java.lang.String getInboundPassword()
      Gets the password used to connect to the account.
      java.lang.Integer getInboundPort()
      Gets the port number with which to connect to the server.
      java.lang.Short getInboundRetryCount()
      Gets the number of retries to perform for a given activity.
      java.lang.Integer getInboundRetryInterval()
      Gets the number of minutes between each retry attempt.
      java.lang.Integer getInboundTime()
      Gets the number of minutes past 12:00am upon which to run the e-mail activity jobs.
      java.lang.Boolean getIsConfigured()
      Gets if the configuration has been done for the store before.
      java.lang.String getOutboundAccount()
      Gets the account name used to connect to the outbound server.
      java.lang.String getOutboundAddress()
      Gets the outbound e-mail address for bounced back mail.
      java.lang.Boolean getOutboundAuthentication()
      Gets the value of the outbound authentication flag.
      java.lang.String getOutboundDescription()
      Gets the e-mail Configuration description.
      java.lang.String getOutboundEmlServer()
      Gets the host name of the outbound e-mail server.
      java.lang.String getOutboundHost()
      Gets the host name of the server upon which to run the e-mail actvity jobs.
      java.lang.Integer getOutboundId()
      Gets the e-mail Configuration ID.
      java.lang.String getOutboundName()
      Gets the e-mail Configuration name.
      java.lang.String getOutboundPassword()
      Gets the password used to connect to the outbound server.
      java.lang.Integer getOutboundPort()
      Gets the port number with which to connect to the outbound server.
      java.lang.Integer getOutboundTime()
      Gets the number of minutes past 12:00am upon which to run the e-mail activity jobs.
      void populate()
      Populate the data bean.
      void setOutboundId(java.lang.Integer id)
      Sets the e-mail configuration ID.
      void setXML(java.util.Hashtable xml)
      Sets the parsed XML data the tools framework passed from the user interface.
      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills
      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties
    • Field Detail

    • Constructor Detail

      • EmailConfigurationDataBean

        public EmailConfigurationDataBean()
    • Method Detail

      • getInboundAccount

        public java.lang.String getInboundAccount()
        Gets the account name used to connect to the server.
        Returns:
        The account name used to connect to the server.
      • getInboundAddress

        public java.lang.String getInboundAddress()
        Gets the inbound e-mail address for bounced back mail.
        Returns:
        The inbound e-mail address for bounced back mail.
      • getInboundDescription

        public java.lang.String getInboundDescription()
        Gets the inbound e-mail description name.
        Returns:
        The description of the inbound e-mail configuration.
      • getInboundEmlServer

        public java.lang.String getInboundEmlServer()
        Gets the host name of the e-mail server.
        Returns:
        The host name of the e-mail server.
      • getInboundHost

        public java.lang.String getInboundHost()
        Gets the host name of the server upon which to run the e-mail activity jobs.
        Returns:
        The host name of the server.
      • getInboundHour

        public java.lang.Integer getInboundHour()
        Gets the hours of the time e-mail activity jobs will run.
        Returns:
        The number of hours.
      • getInboundId

        public java.lang.Integer getInboundId()
        Gets the inbound e-mail configuration ID.
        Returns:
        The ID of the inbound e-mail configuration.
      • getInboundMinute

        public java.lang.Integer getInboundMinute()
        Gets the minutes of the time e-mail activity jobs will run.
        Returns:
        The number of minutes.
      • getInboundName

        public java.lang.String getInboundName()
        Gets the inbound e-mail configuration name.
        Returns:
        The name of the inbound e-mail configuration.
      • getInboundPassword

        public java.lang.String getInboundPassword()
        Gets the password used to connect to the account.
        Returns:
        The password used to connect to the account.
      • getInboundPort

        public java.lang.Integer getInboundPort()
        Gets the port number with which to connect to the server.
        Returns:
        The port number with which to connect to the server.
      • getInboundRetryCount

        public java.lang.Short getInboundRetryCount()
        Gets the number of retries to perform for a given activity.
        Returns:
        The number of retries to perform for a given activity.
      • getInboundRetryInterval

        public java.lang.Integer getInboundRetryInterval()
        Gets the number of minutes between each retry attempt.
        Returns:
        The number of minutes between each retry attempt.
      • getInboundTime

        public java.lang.Integer getInboundTime()
        Gets the number of minutes past 12:00am upon which to run the e-mail activity jobs.
        Returns:
        The number of minutes past 12:00am.
      • getIsConfigured

        public java.lang.Boolean getIsConfigured()
        Gets if the configuration has been done for the store before.
        Returns:
        Boolean type, true means it has been configured before.
      • getOutboundAccount

        public java.lang.String getOutboundAccount()
        Gets the account name used to connect to the outbound server.
        Returns:
        The account name used to connect to the outbound server.
      • getOutboundAddress

        public java.lang.String getOutboundAddress()
        Gets the outbound e-mail address for bounced back mail.
        Returns:
        The outbound e-mail address for bounced back mail.
      • getOutboundAuthentication

        public java.lang.Boolean getOutboundAuthentication()
        Gets the value of the outbound authentication flag.
        Returns:
        True, if authentication is required; false otherwise.
      • getOutboundDescription

        public java.lang.String getOutboundDescription()
        Gets the e-mail Configuration description.
        Returns:
        The description of the e-mail Configuration.
      • getOutboundEmlServer

        public java.lang.String getOutboundEmlServer()
        Gets the host name of the outbound e-mail server.
        Returns:
        The host name of the e-mail server.
      • getOutboundHost

        public java.lang.String getOutboundHost()
        Gets the host name of the server upon which to run the e-mail actvity jobs.
        Returns:
        The host name of the server.
      • getOutboundId

        public java.lang.Integer getOutboundId()
        Gets the e-mail Configuration ID.
        Returns:
        The ID of the e-mail Configuration.
      • getOutboundName

        public java.lang.String getOutboundName()
        Gets the e-mail Configuration name.
        Returns:
        The name of the e-mail Configuration.
      • getOutboundPassword

        public java.lang.String getOutboundPassword()
        Gets the password used to connect to the outbound server. If this method returns null, then an unauthenticated connection will be made. Otherwise, the password will be used to authenticate with the server during the connection.
        Returns:
        The password used to connect to the server.
      • getOutboundPort

        public java.lang.Integer getOutboundPort()
        Gets the port number with which to connect to the outbound server.
        Returns:
        The port number with which to connect to the outbound server.
      • getOutboundTime

        public java.lang.Integer getOutboundTime()
        Gets the number of minutes past 12:00am upon which to run the e-mail activity jobs.
        Returns:
        The number of minutes past 12:00am.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populate the data bean.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown when EmailConfigurationAccessBean cannot retreive the configuration data, or the XML data passed from the POST request cannot be parsed successfully.
      • setOutboundId

        public void setOutboundId(java.lang.Integer id)
        Sets the e-mail configuration ID.
        Parameters:
        id - The e-mail configuration ID.
      • setXML

        public void setXML(java.util.Hashtable xml)
        Sets the parsed XML data the tools framework passed from the user interface.
        Parameters:
        xml - The hashtable representation of the XML that describes this e-mail configuration.