com.ibm.commerce.promotion.uniquecode.commands

Interface CreateUniquePromotionCodeCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

CreateUniquePromotionCodeCmdImpl

public interface CreateUniquePromotionCodeCmd
extends TaskCommand

Interface class for Create Unique Promotion Code command.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	defaultCommandClassName default class name
static java.lang.String	NAME interface name string

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getPxCdpoolId() Returns the newly created promotion code's ID.
java.util.Map	getPxCdpoolIds() Returns a map containing the Promotion Code to PX_CDPOOL_ID Mapping.
void	setPromotionCode(java.lang.String promotionCode) Sets the code for the promotion code.
void	setPromotionCodes(java.util.List<java.lang.String> promotionCodes) Sets the codes for the promotion codes.
void	setPromotionId(java.lang.String promotionId) Sets the promotion id that the promotion code is associated with.
void	setStoreId(java.lang.String storeId) Sets the store id that the promotion code belongs to.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

default class name

NAME

static final java.lang.String NAME

interface name string

Method Detail

setPromotionId

void setPromotionId(java.lang.String promotionId)

Sets the promotion id that the promotion code is associated with.

Parameters:

promotionId - Promotion ID of the promotion that the code is associated with.

setStoreId

void setStoreId(java.lang.String storeId)

Sets the store id that the promotion code belongs to.

Parameters:

storeId - The store id that the promotion code belongs to.

setPromotionCode

void setPromotionCode(java.lang.String promotionCode)

Sets the code for the promotion code. This is the value that the shopper enters to redeem the promotion code.

Parameters:

promotionCode - The code for the promotion code.

setPromotionCodes

void setPromotionCodes(java.util.List<java.lang.String> promotionCodes)

Sets the codes for the promotion codes. This is the value that the shopper enters to redeem the promotion code. If a list of promotion codes is passed in, all promotion codes in the list will be created for the specified promotion.

Parameters:

promotionCodes -

getPxCdpoolIds

java.util.Map getPxCdpoolIds()

Returns a map containing the Promotion Code to PX_CDPOOL_ID Mapping.

Returns:

Map of Promotion Code to PX_CDPOOL_ID. null if creation of new codes failed or if only one code was created.

getPxCdpoolId

java.lang.Long getPxCdpoolId()

Returns the newly created promotion code's ID.

Returns:

the newly created promotion code's ID. null if creation of the new code failed or if more than one code was created.