com.ibm.commerce.tools.campaigns
Interface CampaignCreateCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
CampaignCreateCmdImpl

public interface CampaignCreateCmd
extends 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
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
 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 interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

defaultCommandClassName

public 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.

Name

public static final java.lang.String Name
The name of this interface.
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.
Returns:
An integer of the campaign ID.

setCampaignDescription

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

setCampaignField1

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

setCampaignName

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

setCampaignObjective

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

setCampaignOwner

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

setCampaignStatus

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

setCampaignType

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