com.ibm.commerce.marketing.commands.ranking

Class AbstractGenerateRankingPolicyCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.command.BusinessPolicyCommandImpl

com.ibm.commerce.marketing.commands.ranking.AbstractGenerateRankingPolicyCmdImpl

All Implemented Interfaces:

BusinessPolicyCommand, com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, GenerateRankingPolicyCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

GenerateRankingPolicyCmdImpl

public class AbstractGenerateRankingPolicyCmdImpl
extends BusinessPolicyCommandImpl
implements GenerateRankingPolicyCmd

This is the abstract class to implement the GenerateRankingPolicyCmd interface. It implements the method performExecute and invokes the following methods to generate the ranking list:

• preGenerate - perform any set up
• generate - create the ranking list
• postGenerate - update the ranking list if necessary
• publishRanking - persist the ranking list to the DMRANKINGITEM database table

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.marketing.commands.ranking.GenerateRankingPolicyCmd

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractGenerateRankingPolicyCmdImpl()

Method Summary

Modifier and Type	Method and Description
TypedProperty	getParameterProperties() This method returns the command parameters.
Ranking	getRanking() This method returns the definition of the ranking list.
java.util.Map	getRankingResult() This method returns the map containing the ranking list.
void	performExecute() This method calls the following methods to generate the ranking list: preGenerate - perform any set up generate - create the ranking list postGenerate - update the ranking list if necessary publishRanking - persist the ranking list to the DMRANKINGITEM database table
void	setParameterProperties(TypedProperty newParameterProperties) This method sets the command parameters.
void	setRanking(Ranking newRanking) This method sets the definition of the ranking list.
void	setRankingResult(java.util.Map newRankingResult) This method sets the map containing the ranking list.
void	validateParameters() This method validates that all the required parameters have been set.

Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl

getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AbstractGenerateRankingPolicyCmdImpl

public AbstractGenerateRankingPolicyCmdImpl()

Method Detail

performExecute

public void performExecute()
                    throws ECException

This method calls the following methods to generate the ranking list:

• preGenerate - perform any set up
• generate - create the ranking list
• postGenerate - update the ranking list if necessary
• publishRanking - persist the ranking list to the DMRANKINGITEM database table

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

validateParameters

public void validateParameters()
                        throws ECException

This method validates that all the required parameters have been set.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

getRanking

public Ranking getRanking()

This method returns the definition of the ranking list.

Specified by:

getRanking in interface GenerateRankingPolicyCmd

Returns:

The definition of the ranking list.

setRanking

public void setRanking(Ranking newRanking)

This method sets the definition of the ranking list.

Specified by:

setRanking in interface GenerateRankingPolicyCmd

Parameters:

newRanking - The definition of the ranking list.

getParameterProperties

public TypedProperty getParameterProperties()

This method returns the command parameters.

Returns:

The command parameters.

setParameterProperties

public void setParameterProperties(TypedProperty newParameterProperties)

This method sets the command parameters.

Specified by:

setParameterProperties in interface GenerateRankingPolicyCmd

Parameters:

newParameterProperties - The command parameters.

getRankingResult

public java.util.Map getRankingResult()

This method returns the map containing the ranking list.

Specified by:

getRankingResult in interface GenerateRankingPolicyCmd

Returns:

A map containing the ranking list.

setRankingResult

public void setRankingResult(java.util.Map newRankingResult)

This method sets the map containing the ranking list.

Specified by:

setRankingResult in interface GenerateRankingPolicyCmd

Parameters:

newRankingResult - A map containing the ranking list.