AbstractGenerateRankingPolicyCmdImpl

java.lang.Object
- 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.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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`COLUMN_AMOUNT` Constant for the column AMOUNT.
`protected static java.lang.String`	`COLUMN_OBJECT_ID` Constant for the column OBJECT_ID.
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext

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()

Constructors
Constructor and Description
`AbstractGenerateRankingPolicyCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`generate()` Implementations of this method should generate the ranking list.
`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
`protected void`	`persistRankingItem(java.lang.Integer sequence, java.util.Map datamap, java.lang.Integer rankingId, java.lang.Long groupId, java.lang.Integer storeId)` This method persists a row to the DMRANKINGITEM database table.
`protected void`	`postGenerate()` This method can update the ranking list if necessary.
`protected void`	`preGenerate()` This method can perform any set up required before generating the ranking list.
`protected void`	`publishRanking(java.util.Map rankingResultMap)` This method persists 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 java.lang.Object
clone, equals, finalize, 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
  - COLUMN_OBJECT_ID
```
protected static final java.lang.String COLUMN_OBJECT_ID
```
    Constant for the column OBJECT_ID.
    
    See Also:
    
    Constant Field Values
  - COLUMN_AMOUNT
```
protected static final java.lang.String COLUMN_AMOUNT
```
    Constant for the column AMOUNT.
    
    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
  - preGenerate
```
protected void preGenerate()
                    throws ECException
```
    This method can perform any set up required before generating the ranking list. This implementation currently performs no actions.
    
    Throws:
    
    ECException
  - generate
```
protected void generate()
                 throws ECException
```
    Implementations of this method should generate the ranking list. This implementation currently performs no actions.
    
    Throws:
    
    ECException
  - postGenerate
```
protected void postGenerate()
                     throws ECException
```
    This method can update the ranking list if necessary. This implementation currently performs no actions.
    
    Throws:
    
    ECException
  - publishRanking
```
protected void publishRanking(java.util.Map rankingResultMap)
                       throws ECException
```
    This method persists the ranking list to the DMRANKINGITEM database table.
    
    Parameters:
    
    rankingResultMap - A map of the ranking list.
    
    Throws:
    
    ECException
  - persistRankingItem
```
protected void persistRankingItem(java.lang.Integer sequence,
                      java.util.Map datamap,
                      java.lang.Integer rankingId,
                      java.lang.Long groupId,
                      java.lang.Integer storeId)
                           throws DataMediatorException
```
    This method persists a row to the DMRANKINGITEM database table.
    
    Parameters:
    
    sequence - The sequence of the object in the ranking list.
    
    datamap - A map of data retrieved from the DMRANKINGSTAT database table.
    
    rankingId - The ID of the ranking list.
    
    groupId - The ID of group associated with the object in the ranking list.
    
    storeId - The ID of the store associated with this list.
    
    Throws:
    
    DataMediatorException
  - 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.

Class AbstractGenerateRankingPolicyCmdImpl

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Field Detail

COPYRIGHT

COLUMN_OBJECT_ID

COLUMN_AMOUNT

Constructor Detail

AbstractGenerateRankingPolicyCmdImpl

Method Detail

performExecute

preGenerate

generate

postGenerate

publishRanking

persistRankingItem

validateParameters

getRanking

setRanking

getParameterProperties

setParameterProperties

getRankingResult

setRankingResult