com.ibm.commerce.tools.campaigns
Class CampaignEmsCreateCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.tools.campaigns.CampaignEmsCreateCmdImpl
All Implemented Interfaces:
CampaignEmsCreateCmd, ECCommand, ECTargetableCommand, TaskCommand

public class CampaignEmsCreateCmdImpl
extends TaskCommandImpl
implements CampaignEmsCreateCmd

This class implements the CampaignEmsCreateCmd interface to provide the task command that creates an e-Marketing Spot. Different implementations of this interface can be provided for different stores.

See Also:
Serialized Form

Field Summary
protected  java.lang.String _emsDescription
          e-Marketing Spot description.
protected  java.lang.Integer _emsId
          e-Marketing Spot ID.
protected  java.lang.String _emsName
          e-Marketing Spot name.
protected  java.lang.String _supportedTypes
          e-Marketing Spot supported types.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.tools.campaigns. CampaignEmsCreateCmd
defaultCommandClassName, Name
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
CampaignEmsCreateCmdImpl()
           
 
Method Summary
 java.lang.Integer getEmsId()
          Returns the e-Marketing Spot ID of the newly created e-Marketing Spot.
 boolean isReadyToCallExecute()
          Checks to see if the command is ready to call.
 void performExecute()
          Performs the execution of the command.
 void setEmsDescription(java.lang.String description)
          Sets the e-Marketing Spot description.
 void setEmsName(java.lang.String name)
          Sets the e-Marketing Spot name.
 void setSupportedTypes(java.lang.String supportedTypes)
          Sets the e-Marketing Spot supported types.
 
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, 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
IBM copyright notice field.
See Also:
Constant Field Values

_emsName

protected java.lang.String _emsName
e-Marketing Spot name.

_emsDescription

protected java.lang.String _emsDescription
e-Marketing Spot description.

_supportedTypes

protected java.lang.String _supportedTypes
e-Marketing Spot supported types.

_emsId

protected java.lang.Integer _emsId
e-Marketing Spot ID.
Constructor Detail

CampaignEmsCreateCmdImpl

public CampaignEmsCreateCmdImpl()
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.
Specified by:
getEmsId in interface CampaignEmsCreateCmd
Returns:
An integer of the e-Marketing Spot ID.

isReadyToCallExecute

public boolean isReadyToCallExecute()
Checks to see if the command is ready to call. This method will return false if the e-Marketing Spot name is null.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
true if the command is ready to go.

performExecute

public void performExecute()
                    throws ECException
Performs the execution of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand#performExecute()

setEmsDescription

public void setEmsDescription(java.lang.String description)
Sets the e-Marketing Spot description.
Specified by:
setEmsDescription in interface CampaignEmsCreateCmd
Parameters:
description - The description of the e-Marketing Spot.

setEmsName

public void setEmsName(java.lang.String name)
Sets the e-Marketing Spot name.
Specified by:
setEmsName in interface CampaignEmsCreateCmd
Parameters:
name - The name of the e-Marketing Spot.

setSupportedTypes

public void setSupportedTypes(java.lang.String supportedTypes)
Sets the e-Marketing Spot supported types.
Specified by:
setSupportedTypes in interface CampaignEmsCreateCmd
Parameters:
supportedTypes - The supported types of the e-Marketing Spot.