com.ibm.commerce.tools.campaigns
Interface CampaignEmsCreateCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
CampaignEmsCreateCmdImpl

public interface CampaignEmsCreateCmd
extends TaskCommand

The CampaignEmsCreateCmd interface must be implemented to provide a task command that creates e-marketing spots. Different implementations of this interface can be provided for different stores.


Field Summary
static java.lang.String COPYRIGHT
          Copyright.
static java.lang.String defaultCommandClassName
          defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.tools.campaigns.CampaignEmsCreateCmd is not defined in the CMDREG table.
static java.lang.String Name
          The name of this interface.
 
Method Summary
 java.lang.Integer getEmsId()
          Returns the e-marketing spot ID of the newly created e-marketing spot.
 void setEmsDescription(java.lang.String description)
          Sets the description of the e-marketing spot.
 void setEmsName(java.lang.String name)
          Sets the name of the e-marketing spot.
 void setSupportedTypes(java.lang.String supportedTypes)
          Sets the supported types of the e-marketing spot.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.tools.campaigns.CampaignEmsCreateCmd is not defined in the CMDREG table.

Name

public static final java.lang.String Name
The name of this interface.
Method Detail

getEmsId

public java.lang.Integer getEmsId()
Returns the e-marketing spot ID of the newly created e-marketing spot. You must execute this task command before accessing this value.
Returns:
An integer of the e-marketing spot ID.

setEmsDescription

public void setEmsDescription(java.lang.String description)
Sets the description of the e-marketing spot.
Parameters:
description - The description of the e-marketing spot.

setEmsName

public void setEmsName(java.lang.String name)
Sets the name of the e-marketing spot.
Parameters:
name - The name of the e-marketing spot.

setSupportedTypes

public void setSupportedTypes(java.lang.String supportedTypes)
Sets the supported types of the e-marketing spot.
Parameters:
supportedTypes - The supported types of the e-marketing spot.