com.ibm.commerce.tools.experimentation.commands

Interface CreateExperimentCmd

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:

CreateExperimentCmdImpl

public interface CreateExperimentCmd
extends TaskCommand

The CreateExperimentCmd interface must be implemented to provide a task command that creates an experiment. Different implementations of this interface can be provided for different stores.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName defaultCommandClassName is the default implementation class used by the command factory to instantiate this command if the com.ibm.commerce.tools.experimentation.commands.CreateExperimentCmd interface is not defined in the CMDREG table.
static java.lang.String	NAME The name of this interface.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getExperimentId() This method returns the ID of the experiment which has been created by this command.
void	setDescription(java.lang.String description) This method sets the description of the experiment to be created.
void	setEndDate(java.sql.Timestamp endDate) This method sets the end date of the experiment to be created.
void	setExpireCount(java.lang.Integer expireCount) This method sets the expire count of the experiment to be created, which is used to determine the number of customers to display the experiment to before the experiment expires.
void	setExpTypeId(java.lang.Integer expTypeId) This method sets the ID of the experiment type to which the new experiment will be assigned.
void	setLastUpdate(java.sql.Timestamp lastUpdate) This method sets the last updated date of the experiment to be created.
void	setLastUpdatedBy(java.lang.String lastUpdatedBy) This method sets the logon ID of the user who creates the experiment.
void	setName(java.lang.String name) This method sets the name of the experiment to be created.
void	setPreferredElement(java.lang.Short preferredElement) This method sets the preferred element of the experiment to be created.
void	setPriority(java.lang.Short priority) This method sets the priority of the experiment to be created.
void	setResultScope(java.lang.String resultScope) This method sets the result scope of the experiment to be created.
void	setRuleXml(java.lang.String ruleXml) This method sets the rule XML of the experiment to be created.
void	setStartDate(java.sql.Timestamp startDate) This method sets the start date of the experiment to be created.
void	setStatus(java.lang.String status) This method sets the status of the experiment to be created.
void	setStoreId(java.lang.Integer storeId) This method sets the ID of the store to which the experiment to be created belongs.

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

NAME

static final java.lang.String NAME

The name of this interface.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

defaultCommandClassName is the default implementation class used by the command factory to instantiate this command if the com.ibm.commerce.tools.experimentation.commands.CreateExperimentCmd interface is not defined in the CMDREG table.

See Also:

Constant Field Values

Method Detail

getExperimentId

java.lang.Integer getExperimentId()

This method returns the ID of the experiment which has been created by this command.

Returns:

The ID of the experiment.

setDescription

void setDescription(java.lang.String description)

This method sets the description of the experiment to be created.

Parameters:

description - The description of the experiment.

setEndDate

void setEndDate(java.sql.Timestamp endDate)

This method sets the end date of the experiment to be created.

Parameters:

endDate - The end date of the experiment.

setExpireCount

void setExpireCount(java.lang.Integer expireCount)

This method sets the expire count of the experiment to be created, which is used to determine the number of customers to display the experiment to before the experiment expires.

Parameters:

expireCount - The expire count of the experiment.

setExpTypeId

void setExpTypeId(java.lang.Integer expTypeId)

This method sets the ID of the experiment type to which the new experiment will be assigned.

Parameters:

expTypeId - The ID of the experiment type.

setLastUpdate

void setLastUpdate(java.sql.Timestamp lastUpdate)

This method sets the last updated date of the experiment to be created.

Parameters:

lastUpdate - The last updated date of the experiment.

setLastUpdatedBy

void setLastUpdatedBy(java.lang.String lastUpdatedBy)

This method sets the logon ID of the user who creates the experiment.

Parameters:

lastUpdatedBy - The logon ID of user creating the experiment.

setName

void setName(java.lang.String name)

This method sets the name of the experiment to be created.

Parameters:

name - The name of the experiment.

setPreferredElement

void setPreferredElement(java.lang.Short preferredElement)

This method sets the preferred element of the experiment to be created.

Parameters:

preferredElement - The preferred element of experiment.

setPriority

void setPriority(java.lang.Short priority)

This method sets the priority of the experiment to be created.

Parameters:

priority - The priority of the experiment.

setResultScope

void setResultScope(java.lang.String resultScope)

This method sets the result scope of the experiment to be created.

Parameters:

resultScope - The result scope of the experiment.

setRuleXml

void setRuleXml(java.lang.String ruleXml)

This method sets the rule XML of the experiment to be created.

Parameters:

ruleXml - The rule XML of the experiment.

setStartDate

void setStartDate(java.sql.Timestamp startDate)

This method sets the start date of the experiment to be created.

Parameters:

startDate - The start date of the experiment.

setStatus

void setStatus(java.lang.String status)

This method sets the status of the experiment to be created.

Parameters:

status - The status of the experiment.

setStoreId

void setStoreId(java.lang.Integer storeId)

This method sets the ID of the store to which the experiment to be created belongs.

Parameters:

storeId - The ID of the store to which the experiment belongs.