com.ibm.commerce.tools.campaigns

Interface CampaignCreateCmd

  • 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:
    CampaignCreateCmdImpl


    public interface CampaignCreateCmd
    extends com.ibm.commerce.command.TaskCommand
    The CampaignCreateCmd interface must be implemented to provide a task command that creates 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.CampaignCreateCmd 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
      java.lang.Integer getCampaignId()
      Returns the campaign ID of the newly created campaign.
      void setCampaignDescription(java.lang.String description)
      Sets the description of the campaign.
      void setCampaignField1(java.lang.String field1)
      Sets the custom field of the campaign.
      void setCampaignName(java.lang.String name)
      Sets the name of the campaign.
      void setCampaignObjective(java.lang.String objective)
      Sets the business objective of the campaign.
      void setCampaignOwner(java.lang.String owner)
      Sets the sponsor of the campaign.
      void setCampaignStatus(java.lang.String status)
      Sets the status of the campaign.
      void setCampaignType(java.lang.Integer type)
      Sets the type of the campaign.
      • 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.CampaignCreateCmd is not defined in the CMDREG table.
        See Also:
        Constant Field Values
    • Method Detail

      • getCampaignId

        java.lang.Integer getCampaignId()
        Returns the campaign ID of the newly created campaign. You must execute this task command before accessing this value.
        Returns:
        An integer of the campaign ID.
      • setCampaignDescription

        void setCampaignDescription(java.lang.String description)
        Sets the description of the campaign.
        Parameters:
        description - The description of the campaign.
      • setCampaignField1

        void setCampaignField1(java.lang.String field1)
        Sets the custom field of the campaign.
        Parameters:
        field1 - The custom field of the campaign.
      • setCampaignName

        void setCampaignName(java.lang.String name)
        Sets the name of the campaign.
        Parameters:
        name - The name of the campaign.
      • setCampaignObjective

        void setCampaignObjective(java.lang.String objective)
        Sets the business objective of the campaign.
        Parameters:
        objective - The business objective of the campaign.
      • setCampaignOwner

        void setCampaignOwner(java.lang.String owner)
        Sets the sponsor of the campaign.
        Parameters:
        owner - The sponsor of the campaign.
      • setCampaignStatus

        void setCampaignStatus(java.lang.String status)
        Sets the status of the campaign.
        Parameters:
        status - The status of the campaign.
      • setCampaignType

        void setCampaignType(java.lang.Integer type)
        Sets the type of the campaign.
        Parameters:
        type - The type of the campaign.