com.ibm.commerce.tools.campaigns

Interface CampaignCollateralCreateCmd

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

    public interface CampaignCollateralCreateCmd
extends com.ibm.commerce.command.TaskCommand
    The CampaignCollateralCreateCmd interface must be implemented to provide a task command that creates ad copy. 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.CampaignCollateralCreateCmd 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 getCollateralId()
      Returns the collateral ID of the newly created ad copy.
      void setCollateralDescriptionField1(java.lang.String field1)
      Sets the description field 1 of the ad copy.
      void setCollateralDescriptionField2(java.lang.String field2)
      Sets the description field 2 of the ad copy.
      void setCollateralField1(java.lang.String field1)
      Sets the custom field 1 of the ad copy.
      void setCollateralField2(java.lang.String field2)
      Sets the custom field 2 of the ad copy.
      void setCollateralLocation(java.lang.String location)
      Sets the image file location of the ad copy.
      void setCollateralMarketingText(java.lang.String text)
      Sets the marketing text of the ad copy.
      void setCollateralName(java.lang.String name)
      Sets the name of the ad copy.
      void setCollateralType(java.lang.Integer type)
      Sets the image type of the ad copy.
      void setCollateralUrl(java.lang.String url)
      Sets the URL of the ad copy.

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

    • Method Detail

      • getCollateralId

        java.lang.Integer getCollateralId()
        Returns the collateral ID of the newly created ad copy. You must execute this task command before accessing this value.
        Returns:
        An integer of the collateral ID.

      • setCollateralDescriptionField1

        void setCollateralDescriptionField1(java.lang.String field1)
        Sets the description field 1 of the ad copy.
        Parameters:
        field1 - The first description field of the ad copy.

      • setCollateralDescriptionField2

        void setCollateralDescriptionField2(java.lang.String field2)
        Sets the description field 2 of the ad copy.
        Parameters:
        field2 - The second description field of the ad copy.

      • setCollateralField1

        void setCollateralField1(java.lang.String field1)
        Sets the custom field 1 of the ad copy.
        Parameters:
        field1 - The first custom field of the ad copy.

      • setCollateralField2

        void setCollateralField2(java.lang.String field2)
        Sets the custom field 2 of the ad copy.
        Parameters:
        field2 - The second custom field of the ad copy.

      • setCollateralLocation

        void setCollateralLocation(java.lang.String location)
        Sets the image file location of the ad copy.
        Parameters:
        location - The image full qualify path and file location of the ad copy.

      • setCollateralMarketingText

        void setCollateralMarketingText(java.lang.String text)
        Sets the marketing text of the ad copy.
        Parameters:
        text - The marketing text of the ad copy, which is to be displayed beside the ad copy image.

      • setCollateralName

        void setCollateralName(java.lang.String name)
        Sets the name of the ad copy.
        Parameters:
        name - The name of the ad copy.

      • setCollateralType

        void setCollateralType(java.lang.Integer type)
        Sets the image type of the ad copy.
        Parameters:
        type - The image type of the ad copy.

      • setCollateralUrl

        void setCollateralUrl(java.lang.String url)
        Sets the URL of the ad copy.
        Parameters:
        url - The URL of the ad copy.
Skip navigation links