com.ibm.commerce.marketing.commands.ranking

Interface CleanupRankingPolicyCmd

All Superinterfaces:

BusinessPolicyCommand, 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:

AbstractCleanupRankingPolicyCmdImpl, CleanupRankingPolicyCmdImpl

public interface CleanupRankingPolicyCmd
extends BusinessPolicyCommand

The CleanupRankingPolicyCmd is the interface for all ranking cleanup business policy command implementations. Each ranking policy must have one cleanup policy command which will be used to remove any out of date statistic data and to summarize existing statistic data to reduce the size of the table.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default name of this command.
static java.lang.String	MODE_IMMEDIATE Constant for clean mode "Immediate".
static java.lang.String	MODE_LAST_DAY Constant for clean mode "LastDay".
static java.lang.String	MODE_LAST_HOUR Constant for clean mode "LastHour".
static java.lang.String	NAME The name of this command.
static java.lang.String	PARAM_CLEAN_INTERVAL Constant for parameter "CleanInterval".
static java.lang.String	PARAM_CLEAN_MODE Constant for parameter "CleanMode".
static java.lang.String	PARAM_VALID_PERIOD Constant for parameter "ValidPeriod".

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	cleanup() This method cleans up any unnecessary ranking statistic data.
void	setRanking(Ranking ranking) This method sets the ranking definition object.

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

getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

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

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default name of this command.

PARAM_CLEAN_INTERVAL

static final java.lang.String PARAM_CLEAN_INTERVAL

Constant for parameter "CleanInterval".

See Also:

Constant Field Values

PARAM_VALID_PERIOD

static final java.lang.String PARAM_VALID_PERIOD

Constant for parameter "ValidPeriod".

See Also:

Constant Field Values

PARAM_CLEAN_MODE

static final java.lang.String PARAM_CLEAN_MODE

Constant for parameter "CleanMode".

See Also:

Constant Field Values

MODE_LAST_DAY

static final java.lang.String MODE_LAST_DAY

Constant for clean mode "LastDay". In this mode, the cleanup will start from the end of the last day.

See Also:

Constant Field Values

MODE_LAST_HOUR

static final java.lang.String MODE_LAST_HOUR

Constant for clean mode "LastHour". In this mode, the cleanup will start from the end of last hour.

See Also:

Constant Field Values

MODE_IMMEDIATE

static final java.lang.String MODE_IMMEDIATE

Constant for clean mode "Immediate". In this mode, the cleanup will start from right now.

See Also:

Constant Field Values

Method Detail

cleanup

void cleanup()
      throws ECException

This method cleans up any unnecessary ranking statistic data.

Throws:

ECException

setRanking

void setRanking(Ranking ranking)
         throws ECException

This method sets the ranking definition object.

Parameters:

ranking - The ranking object.

Throws:

ECException