com.ibm.commerce.tools.campaigns
Class CampaignDeleteCmdImpl

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

public class CampaignDeleteCmdImpl
extends TaskCommandImpl
implements CampaignDeleteCmd

This class implements the CampaignDeleteCmd interface to provide the task command that deletes campaigns. Different implementations of this interface can be provided for different stores.

See Also:
Serialized Form

Field Summary
protected  java.lang.Integer _campaignId
          Campaign ID.
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. CampaignDeleteCmd
defaultCommandClassName, Name
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
CampaignDeleteCmdImpl()
           
 
Method Summary
 boolean isReadyToCallExecute()
          Checks to see if the command is ready to call.
 void performExecute()
          Performs the execution of the command.
 void setCampaignId(java.lang.Integer campaignId)
          Sets the campaign ID.
 
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

_campaignId

protected java.lang.Integer _campaignId
Campaign ID.
Constructor Detail

CampaignDeleteCmdImpl

public CampaignDeleteCmdImpl()
Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()
Checks to see if the command is ready to call. This method will return false if the campaign ID 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()

setCampaignId

public void setCampaignId(java.lang.Integer campaignId)
Sets the campaign ID. This parameter is required.
Specified by:
setCampaignId in interface CampaignDeleteCmd
Parameters:
campaignId - The ID of the campaign to be deleted.