com.ibm.commerce.emarketing.beans
Class EmailConfigurationDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.emarketing.beans.EmailConfigurationDataBeanBase
                    |
                    +--com.ibm.commerce.emarketing.beans.EmailConfigurationDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class EmailConfigurationDataBean
extends EmailConfigurationDataBeanBase

Used to lookup e-mail server configurations for the current store.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
EmailConfigurationDataBean()
           
 
Method Summary
 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 bounce back mail
 java.lang.String getInboundDescription()
          Gets the inbound e-mail description name.
 java.lang.String getInboundEmlServer()
          Gets the hostname of the e-mail server.
 java.lang.String getInboundHost()
          Gets the hostname of the server upon which to run the e-mail actvity 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.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 bounce 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 hostname of the outbound e-mail server
 java.lang.String getOutboundHost()
          Gets the hostname 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 GUI.
 
Methods inherited from class com.ibm.commerce.emarketing.beans. EmailConfigurationDataBeanBase
getDelegate, getOwner
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright.
See Also:
Constant Field Values
Constructor Detail

EmailConfigurationDataBean

public EmailConfigurationDataBean()
Method Detail

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.

getOutboundDescription

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

getOutboundHost

public java.lang.String getOutboundHost()
Gets the hostname of the server upon which to run the e-mail actvity jobs
Returns:
The hostname of the 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

getOutboundEmlServer

public java.lang.String getOutboundEmlServer()
Gets the hostname of the outbound e-mail server
Returns:
The hostname of the e-mail server

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 bounce back mail
Returns:
The outbound e-mail address for bounce back mail

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

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

getOutboundAuthentication

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

getInboundId

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

getInboundName

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

getInboundDescription

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

getInboundHost

public java.lang.String getInboundHost()
Gets the hostname of the server upon which to run the e-mail actvity jobs
Returns:
The hostname of the server

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

getInboundHour

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

getInboundMinute

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

getInboundEmlServer

public java.lang.String getInboundEmlServer()
Gets the hostname of the e-mail server.
Returns:
The hostname of the e-mail server

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 bounce back mail
Returns:
The inbound e-mail address for bounce back mail

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

getInboundPassword

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

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

setXML

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

populate

public void populate()
              throws java.lang.Exception
populate the data bean.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class 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.