com.ibm.commerce.marketing.promotion.commands

Interface SimulatedPromotionEvaluationTaskCmd

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:

SimulatedPromotionEvaluationTaskCmdImpl

public interface SimulatedPromotionEvaluationTaskCmd
extends TaskCommand

The command interface to evaluate a simulated order.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName Default implementation class for this command.
static long	GENERIC_USER_ID The generic user ID -1002.
static java.math.BigDecimal	ONE The constant - ONE.
static java.lang.Long	SIMULATED_GENERIC_USER_ID The generic user ID to use.
static long	SIMULATED_ID The ID constant uses for simulated order and order item.
static java.lang.Long	SIMULATED_ORDER_ID The simulated order ID.
static java.math.BigDecimal	ZERO The constant - ZERO.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
PromotionArgument	getEvaluationResult() Gets the promotion evaluation result.
void	setOrder(Order aOrder) Sets simulated order.
void	setPromotionIDs(java.util.List<java.lang.String> aPromotionIDs) Sets a list of promotion IDs that will be evaluated.
void	setPromotionTemplateName(java.lang.String aTemplateName) Sets the promotion template name.
void	setSimulatedConfiguration(java.util.Map<java.lang.String,java.lang.String> aSimulatedConfiguration) Sets the optional simulated configurations.

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 implementation class for this command.

SIMULATED_ID

static final long SIMULATED_ID

The ID constant uses for simulated order and order item.

See Also:

Constant Field Values

SIMULATED_ORDER_ID

static final java.lang.Long SIMULATED_ORDER_ID

The simulated order ID.

GENERIC_USER_ID

static final long GENERIC_USER_ID

The generic user ID -1002.

See Also:

Constant Field Values

SIMULATED_GENERIC_USER_ID

static final java.lang.Long SIMULATED_GENERIC_USER_ID

The generic user ID to use. Value of -1002.

ZERO

static final java.math.BigDecimal ZERO

The constant - ZERO.

ONE

static final java.math.BigDecimal ONE

The constant - ONE.

Method Detail

setPromotionTemplateName

void setPromotionTemplateName(java.lang.String aTemplateName)

Sets the promotion template name.

Parameters:

aTemplateName - The promotion template name to set.

setPromotionIDs

void setPromotionIDs(java.util.List<java.lang.String> aPromotionIDs)

Sets a list of promotion IDs that will be evaluated. If this list is empty, the command will evaluate all available promotions according to the specified promotion template.

Parameters:

aPromotionIDs - A list of promotion IDs.

setOrder

void setOrder(Order aOrder)

Sets simulated order. This method must be called before the evaluation process starts.

Parameters:

aOrder - The simulated order object.

setSimulatedConfiguration

void setSimulatedConfiguration(java.util.Map<java.lang.String,java.lang.String> aSimulatedConfiguration)

Sets the optional simulated configurations.

Parameters:

aSimulatedComponents - A map of optional simulated configurations.

getEvaluationResult

PromotionArgument getEvaluationResult()

Gets the promotion evaluation result.

Returns:

The result PromotionArgument object.