com.ibm.commerce.tools.campaigns
Interface CampaignCollateralCreateCmd

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

public interface CampaignCollateralCreateCmd
extends 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
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
 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 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.CampaignCollateralCreateCmd is not defined in the CMDREG table.

Name

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

setCollateralDescriptionField1

public 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

public 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

public 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

public 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

public 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

public 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

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

setCollateralType

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

setCollateralUrl

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