com.ibm.commerce.tools.campaigns

Interface CampaignEmsCreateCmd

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

    public interface CampaignEmsCreateCmd
extends com.ibm.commerce.command.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

      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.CampaignEmsCreateCmd 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 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.
      void setUsageType(java.lang.String usageType)
      Sets the usage type of the e-Marketing Spot.

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

    • Method Detail

      • getEmsId

        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

        void setEmsDescription(java.lang.String description)
        Sets the description of the e-Marketing Spot.
        Parameters:
        description - The description of the e-Marketing Spot.

      • setEmsName

        void setEmsName(java.lang.String name)
        Sets the name of the e-Marketing Spot.
        Parameters:
        name - The name of the e-Marketing Spot.

      • setSupportedTypes

        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.

      • setUsageType

        void setUsageType(java.lang.String usageType)
        Sets the usage type of the e-Marketing Spot.
        Parameters:
        usageType - The usage type of the e-Marketing Spot.
Skip navigation links