com.ibm.commerce.tools.campaigns

Class CampaignCollateralCreateCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.CacheableCommandImpl
      • com.ibm.commerce.command.MeasuredCacheableCommandImpl
        • com.ibm.commerce.command.AbstractECTargetableCommand
          • com.ibm.commerce.command.TaskCommandImpl
            • com.ibm.commerce.tools.campaigns.CampaignCollateralCreateCmdImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, CampaignCollateralCreateCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class CampaignCollateralCreateCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements CampaignCollateralCreateCmd
    This class implements the CampaignCollateralCreateCmd interface to provide the task command that creates an ad copy. Different implementations of this interface can be provided for different stores.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Integer getCollateralId()
      Returns the collateral ID of the newly created ad copy.
      boolean isReadyToCallExecute()
      Checks to see if the command is ready to call.
      void performExecute()
      Performs the execution of the command.
      void setCollateralDescriptionField1(java.lang.String field1)
      Sets the collateral description field 1.
      void setCollateralDescriptionField2(java.lang.String field2)
      Sets the collateral description field 2.
      void setCollateralField1(java.lang.String field1)
      Sets the collateral custom field 1.
      void setCollateralField2(java.lang.String field2)
      Sets the collateral custom field 2.
      void setCollateralLocation(java.lang.String location)
      Sets the collateral image file location.
      void setCollateralMarketingText(java.lang.String text)
      Sets the collateral marketing text.
      void setCollateralName(java.lang.String name)
      Sets the name of the collateral.
      void setCollateralType(java.lang.Integer type)
      Sets the image type of the collateral.
      void setCollateralUrl(java.lang.String url)
      Sets the URL of the collateral.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

        accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

      • 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CampaignCollateralCreateCmdImpl

        public CampaignCollateralCreateCmdImpl()

    • Method Detail

      • getCollateralId

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

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Checks to see if the command is ready to call. This method will return false if the collateral ID is null.
        Overrides:
        isReadyToCallExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Returns:
        true if the command is ready to go.

      • performExecute

        public void performExecute()
                    throws com.ibm.commerce.exception.ECException
        Performs the execution of the command.
        Specified by:
        performExecute in interface com.ibm.commerce.command.ECCommand
        Overrides:
        performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
        Throws:
        com.ibm.commerce.exception.ECException
        See Also:
        ECCommand#performExecute()

      • setCollateralDescriptionField1

        public void setCollateralDescriptionField1(java.lang.String field1)
        Sets the collateral description field 1.
        Specified by:
        setCollateralDescriptionField1 in interface CampaignCollateralCreateCmd
        Parameters:
        field1 - The description field 1 of the collateral.

      • setCollateralDescriptionField2

        public void setCollateralDescriptionField2(java.lang.String field2)
        Sets the collateral description field 2.
        Specified by:
        setCollateralDescriptionField2 in interface CampaignCollateralCreateCmd
        Parameters:
        field2 - The description field 2 of the collateral.

      • setCollateralField1

        public void setCollateralField1(java.lang.String field1)
        Sets the collateral custom field 1.
        Specified by:
        setCollateralField1 in interface CampaignCollateralCreateCmd
        Parameters:
        field1 - The custom field 1 of the collateral.

      • setCollateralField2

        public void setCollateralField2(java.lang.String field2)
        Sets the collateral custom field 2.
        Specified by:
        setCollateralField2 in interface CampaignCollateralCreateCmd
        Parameters:
        field2 - The custom field 2 of the collateral.

      • setCollateralLocation

        public void setCollateralLocation(java.lang.String location)
        Sets the collateral image file location.
        Specified by:
        setCollateralLocation in interface CampaignCollateralCreateCmd
        Parameters:
        location - The image file location of the collateral.

      • setCollateralMarketingText

        public void setCollateralMarketingText(java.lang.String text)
        Sets the collateral marketing text.
        Specified by:
        setCollateralMarketingText in interface CampaignCollateralCreateCmd
        Parameters:
        text - The marketing text of the collateral.

      • setCollateralName

        public void setCollateralName(java.lang.String name)
        Sets the name of the collateral.
        Specified by:
        setCollateralName in interface CampaignCollateralCreateCmd
        Parameters:
        name - The name of the collateral.

      • setCollateralType

        public void setCollateralType(java.lang.Integer type)
        Sets the image type of the collateral.
        Specified by:
        setCollateralType in interface CampaignCollateralCreateCmd
        Parameters:
        type - The image type of the collateral.

      • setCollateralUrl

        public void setCollateralUrl(java.lang.String url)
        Sets the URL of the collateral.
        Specified by:
        setCollateralUrl in interface CampaignCollateralCreateCmd
        Parameters:
        url - The URL of the collateral.
Skip navigation links