com.ibm.commerce.tools.campaigns

Interface CampaignDeleteCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    CampaignDeleteCmdImpl


    public interface CampaignDeleteCmd
    extends com.ibm.commerce.command.TaskCommand
    The CampaignDeleteCmd interface must be implemented to provide a task command that deletes campaigns. Different implementations of this interface can be provided for different stores.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      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.CampaignDeleteCmd is not defined in the CMDREG table.
      static java.lang.String Name
      The name of this interface.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void setCampaignId(java.lang.Integer campaignId)
      Sets the campaign ID.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute
      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
    • Field Detail

      • defaultCommandClassName

        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.CampaignDeleteCmd is not defined in the CMDREG table.
        See Also:
        Constant Field Values
    • Method Detail

      • setCampaignId

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