com.ibm.commerce.emarketing.commands
Class EmailConfigurationSaveTaskCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.emarketing.commands.EmailConfigurationSaveTaskCmdImpl
All Implemented Interfaces:
ECCommand, ECTargetableCommand, EmailConfigurationSaveTaskCmd, TaskCommand
Direct Known Subclasses:
EmailConfigurationCreateTaskCmdImpl, EmailConfigurationUpdateTaskCmdImpl

public class EmailConfigurationSaveTaskCmdImpl
extends TaskCommandImpl
implements EmailConfigurationSaveTaskCmd

The default implementation of EmailConfigurationSaveTaskCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
EmailConfigurationSaveTaskCmdImpl()
           
 
Method Summary
 java.lang.String getAccount()
          Gets the account name used to connect to the e-mail server.
 java.lang.String getAddress()
          Gets the e-mail address of the account used on the e-mail server.
 java.lang.String getDescription()
          Gets the description of the e-mail configuration.
 java.lang.Integer getEmailConfigurationId()
          Gets the ID of the e-mail configuration.
 java.lang.String getEmailServer()
          Gets the host name of the e-mail server for this configuration.
 java.lang.String getHost()
          Gets the commerce host that will run the e-mail activities for the given store.
 java.lang.String getName()
          Gets the name of the e-mail configuration.
 java.lang.String getPassword()
          Gets the account password used to connect to the e-mail server.
 java.lang.Integer getPort()
          Gets the port through which connections will be made to the e-mail server.
 java.lang.Integer getStoreEntityId()
          get the ID of the store associated with the e-mail configuration.
 java.lang.Integer getTime()
          Gets the time of day (as number of minutes since 00:00) when communication with this server will be attempted to complete the jobs assigned.
 java.lang.Integer getType()
          Gets the type of e-mail server being configured.
 void setAccount(java.lang.String account)
          Sets the account to be used on the e-mail server that will be logged into for performing e-mail activity jobs.
 void setAddress(java.lang.String address)
          Sets the e-mail address of the account on the e-mail server.
 void setDescription(java.lang.String description)
          Sets the description of the e-mail Configuration.
 void setEmailConfigurationAttributes(java.lang.String name, java.lang.String description, java.lang.Integer storeEntityId, java.lang.Integer type, java.lang.String host, java.lang.String emailServer, java.lang.String account, java.lang.Integer port, java.lang.String password, java.lang.Integer time)
          This method sets all the attributes needed to configure an e-mail server EXCEPT the primary key emailConfigurationId.
 void setEmailConfigurationId(java.lang.Integer emailConfigurationId)
          Sets the ID of the e-mail configuration This is only to be called if an update to an existing configuration is required.
 void setEmailServer(java.lang.String emailServer)
          Sets the hostname of the server to use for e-mail activities (either inbound or outbound).
 void setHost(java.lang.String host)
          Sets the commerce host used to perform e-mail activity jobs.
 void setName(java.lang.String name)
          Sets the name of the e-mail configuration.
 void setPassword(java.lang.String password)
          Sets the password to the account on the e-mail server.
 void setPort(java.lang.Integer port)
          Sets the port number through which to connect to the e-mail server.
 void setStoreEntityId(java.lang.Integer storeEntityId)
          Sets the ID of the store for the e-mail configuration.
 void setTime(java.lang.Integer time)
          Sets the time of a day when inbound/outbound e-mail activities will occur.
 void setType(java.lang.Integer type)
          Sets the type of the e-mail configuration.
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

EmailConfigurationSaveTaskCmdImpl

public EmailConfigurationSaveTaskCmdImpl()
Method Detail

setEmailConfigurationId

public void setEmailConfigurationId(java.lang.Integer emailConfigurationId)
Sets the ID of the e-mail configuration This is only to be called if an update to an existing configuration is required.
Specified by:
setEmailConfigurationId in interface EmailConfigurationSaveTaskCmd
Parameters:
emailConfigurationId - the ID of the e-mail configuration.

getEmailConfigurationId

public java.lang.Integer getEmailConfigurationId()
Gets the ID of the e-mail configuration.
Specified by:
getEmailConfigurationId in interface EmailConfigurationSaveTaskCmd
Returns:
the ID of the e-mail configuration.

setName

public void setName(java.lang.String name)
Sets the name of the e-mail configuration.
Specified by:
setName in interface EmailConfigurationSaveTaskCmd
Parameters:
name - the name of the e-mail configuration.

getName

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

getDescription

public java.lang.String getDescription()
Gets the description of the e-mail configuration.
Returns:
the description of the e-mail configuration.

getStoreEntityId

public java.lang.Integer getStoreEntityId()
get the ID of the store associated with the e-mail configuration.
Returns:
the store ID.

getType

public java.lang.Integer getType()
Gets the type of e-mail server being configured.
Returns:
0 if this is an SMTP server configuration; 1 if this is a POP3 configuration.

getHost

public java.lang.String getHost()
Gets the commerce host that will run the e-mail activities for the given store.
Returns:
the commerce host that will run the e-mail activities for the given store.

getEmailServer

public java.lang.String getEmailServer()
Gets the host name of the e-mail server for this configuration.
Returns:
the host name of the e-mail server for this configuration.

getPort

public java.lang.Integer getPort()
Gets the port through which connections will be made to the e-mail server.
Returns:
the port through which connections will be made to the e-mail server.

getAddress

public java.lang.String getAddress()
Gets the e-mail address of the account used on the e-mail server.
Returns:
the e-mail address of the account used on the e-mail server.

getAccount

public java.lang.String getAccount()
Gets the account name used to connect to the e-mail server.
Returns:
the account name used to connect to the e-mail server.

getPassword

public java.lang.String getPassword()
Gets the account password used to connect to the e-mail server. If this configuration is an SMTP configuration, the password will only be used if the server requires authentication.
Returns:
the password used.

getTime

public java.lang.Integer getTime()
Gets the time of day (as number of minutes since 00:00) when communication with this server will be attempted to complete the jobs assigned.
Returns:
the time of day.

setDescription

public void setDescription(java.lang.String description)
Sets the description of the e-mail Configuration.
Specified by:
setDescription in interface EmailConfigurationSaveTaskCmd
Parameters:
description - the description of the e-mail Configuration.

setStoreEntityId

public void setStoreEntityId(java.lang.Integer storeEntityId)
Sets the ID of the store for the e-mail configuration.
Specified by:
setStoreEntityId in interface EmailConfigurationSaveTaskCmd
Parameters:
storeEntityId - the ID of the store for the e-mail configuration.

setType

public void setType(java.lang.Integer type)
Sets the type of the e-mail configuration.
Specified by:
setType in interface EmailConfigurationSaveTaskCmd
Parameters:
type - the type of the e-mail configuration. Set to 0 for an SMTP configuration; 1 for a POP3 configuration.

setHost

public void setHost(java.lang.String host)
Sets the commerce host used to perform e-mail activity jobs.
Specified by:
setHost in interface EmailConfigurationSaveTaskCmd
Parameters:
host - the commerce host used to perform e-mail activity jobs.

setEmailServer

public void setEmailServer(java.lang.String emailServer)
Sets the hostname of the server to use for e-mail activities (either inbound or outbound).
Specified by:
setEmailServer in interface EmailConfigurationSaveTaskCmd
Parameters:
emailServer - the hostname of the e-mail server.

setAccount

public void setAccount(java.lang.String account)
Sets the account to be used on the e-mail server that will be logged into for performing e-mail activity jobs.
Specified by:
setAccount in interface EmailConfigurationSaveTaskCmd
Parameters:
account - the account.

setPort

public void setPort(java.lang.Integer port)
Sets the port number through which to connect to the e-mail server.
Specified by:
setPort in interface EmailConfigurationSaveTaskCmd
Parameters:
port - the port.

setPassword

public void setPassword(java.lang.String password)
Sets the password to the account on the e-mail server.
Specified by:
setPassword in interface EmailConfigurationSaveTaskCmd

setTime

public void setTime(java.lang.Integer time)
Sets the time of a day when inbound/outbound e-mail activities will occur.
Specified by:
setTime in interface EmailConfigurationSaveTaskCmd
Parameters:
time - the time of day represented as the number of minutes since 00:00.

setAddress

public void setAddress(java.lang.String address)
Sets the e-mail address of the account on the e-mail server.
Specified by:
setAddress in interface EmailConfigurationSaveTaskCmd
Parameters:
address - the e-mail address.

setEmailConfigurationAttributes

public void setEmailConfigurationAttributes(java.lang.String name,
                                            java.lang.String description,
                                            java.lang.Integer storeEntityId,
                                            java.lang.Integer type,
                                            java.lang.String host,
                                            java.lang.String emailServer,
                                            java.lang.String account,
                                            java.lang.Integer port,
                                            java.lang.String password,
                                            java.lang.Integer time)
This method sets all the attributes needed to configure an e-mail server EXCEPT the primary key emailConfigurationId.
Specified by:
setEmailConfigurationAttributes in interface EmailConfigurationSaveTaskCmd
Parameters:
name - The name assigned to this e-mail configuration.
description - The description assigned to this e-mail configuration.
storeEntityId - The storeEntityId.
type - The type of e-mail server for which this configuration is made.
host - The commerce host that will handle this e-mail configuration's processes.
emailServer - The host name of the e-mail server to use.
account - The user account name to use on the e-mail server.
port - The port under which to connect to the e-mail server.
password - The user account password to use to connect to the server.
time - The number of minutes from 00:00 to start processing e-mail.