com.ibm.commerce.tools.campaigns

Class CampaignCreateCmdImpl

  • 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.CampaignCreateCmdImpl
  • All Implemented Interfaces:
    com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, CampaignCreateCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

    public class CampaignCreateCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements CampaignCreateCmd
    This class implements the CampaignCreateCmd interface to provide the task command that creates a campaign. 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 getCampaignId()
      Returns the campaign ID of the newly created campaign.
      boolean isReadyToCallExecute()
      Checks to see if the command is ready to call.
      void performExecute()
      Performs the execution of the command.
      void setCampaignDescription(java.lang.String description)
      Sets the campaign description.
      void setCampaignField1(java.lang.String field1)
      Sets the campaign custom field.
      void setCampaignName(java.lang.String name)
      Sets the campaign name.
      void setCampaignObjective(java.lang.String objective)
      Sets the campaign business objective.
      void setCampaignOwner(java.lang.String owner)
      Sets the campaign sponsor.
      void setCampaignStatus(java.lang.String status)
      Sets the campaign status.
      void setCampaignType(java.lang.Integer type)
      Sets the campaign type.

      • 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

      • CampaignCreateCmdImpl

        public CampaignCreateCmdImpl()

    • Method Detail

      • getCampaignId

        public java.lang.Integer getCampaignId()
        Returns the campaign ID of the newly created campaign. You must execute this task command before accessing this value.
        Specified by:
        getCampaignId in interface CampaignCreateCmd
        Returns:
        An integer of the campaign ID.

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Checks to see if the command is ready to call. This method will return false if the campaign name 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()

      • setCampaignDescription

        public void setCampaignDescription(java.lang.String description)
        Sets the campaign description.
        Specified by:
        setCampaignDescription in interface CampaignCreateCmd
        Parameters:
        description - The description of the campaign.

      • setCampaignField1

        public void setCampaignField1(java.lang.String field1)
        Sets the campaign custom field.
        Specified by:
        setCampaignField1 in interface CampaignCreateCmd
        Parameters:
        field1 - The custom field of the campaign.

      • setCampaignName

        public void setCampaignName(java.lang.String name)
        Sets the campaign name.
        Specified by:
        setCampaignName in interface CampaignCreateCmd
        Parameters:
        name - The name of the campaign.

      • setCampaignObjective

        public void setCampaignObjective(java.lang.String objective)
        Sets the campaign business objective.
        Specified by:
        setCampaignObjective in interface CampaignCreateCmd
        Parameters:
        objective - The business objective of the campaign.

      • setCampaignOwner

        public void setCampaignOwner(java.lang.String owner)
        Sets the campaign sponsor.
        Specified by:
        setCampaignOwner in interface CampaignCreateCmd
        Parameters:
        owner - The sponsor of the campaign.

      • setCampaignStatus

        public void setCampaignStatus(java.lang.String status)
        Sets the campaign status.
        Specified by:
        setCampaignStatus in interface CampaignCreateCmd
        Parameters:
        status - The status of the campaign.

      • setCampaignType

        public void setCampaignType(java.lang.Integer type)
        Sets the campaign type.
        Specified by:
        setCampaignType in interface CampaignCreateCmd
        Parameters:
        type - The type of the campaign.
Skip navigation links