com.ibm.commerce.negotiation.bean.commands
Class ControlRuleListBeanCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.DataBeanCommandImpl
                    |
                    +--com.ibm.commerce.negotiation.bean.commands.ControlRuleListBeanCmdImpl
All Implemented Interfaces:
ControlRuleListBeanCmd, DataBeanCommand, ECCommand, ECTargetableCommand

public class ControlRuleListBeanCmdImpl
extends DataBeanCommandImpl
implements ControlRuleListBeanCmd

This class will fetch an array of ControlRuleDataBean for ControlRuleListBean This command uses the following AccessBeans:

This command uses the following DataBeans:
See Also:
Serialized Form

Field Summary
protected  com.ibm.commerce.negotiation.objects.ControlRuleAccessBean controlRuleAccessBean
          Instance variable to store a access bean.
static java.lang.String COPYRIGHT
          Copyright statement.
protected  java.lang.Long ownerId
          Instance variable to store ownerId used for list population
protected  java.lang.String ruleName
          Instance variable to store the rule name.
protected  java.lang.String ruleType
          Instance variable to store the control rule type used for list population
 
Fields inherited from class com.ibm.commerce.command. DataBeanCommandImpl
dataBean, emptyString, EURO_CODE, requestProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.negotiation.bean.commands. ControlRuleListBeanCmd
defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
ControlRuleListBeanCmdImpl()
           
 
Method Summary
 com.ibm.commerce.negotiation.objects.ControlRuleAccessBean getControlRule()
          Fetches a ControlRule from the list.
 java.lang.Long getOwnerId()
          Fetches the ownerId used for list population.
 java.lang.String getRuleName()
          Fetches the control rule name used for list population.
 java.lang.String getRuleType()
          Fetches the control rule type used for list population.
 boolean isReadyToCallExecute()
          This method is called by the Targettable Command frame work before the execution of the command.
 void performExecute()
          Populates a list of control rules matching specific criteria, in the following precedence: - by match on both the ownerId and ruleType - by match on both the ownerId and ruleName - by macthing ownerId - a list of all rules
 void populateDataBeanCommand( InputDataBean aDataBean)
          Get input data (OwnerId, RuleType, or RuleName) from ControlRuleListBean
 void reset()
          Resets the bean.
 void setControlRule(com.ibm.commerce.negotiation.objects.ControlRuleAccessBean newControlRuleAccessBean)
          Provides an access bean instance for returning an element from the list.
 void setOwnerId(java.lang.Long newOwnerId)
          Sets the ownerId used by the finder methods to populate the list.
 void setRequestProperties( TypedProperty properties)
          Obtains command parameters from TypedProperty; current implementation does nothing.
 void setRuleName(java.lang.String newRuleName)
          Sets the rule name used by the finder method to populate the list.
 void setRuleType(java.lang.String newRuleType)
          Sets the ruleType used by the finder methods to populate the list.
 
Methods inherited from class com.ibm.commerce.command. DataBeanCommandImpl
convertToString, getDataBean, setDataBean
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright statement.
See Also:
Constant Field Values

ownerId

protected java.lang.Long ownerId
Instance variable to store ownerId used for list population

ruleType

protected java.lang.String ruleType
Instance variable to store the control rule type used for list population

controlRuleAccessBean

protected com.ibm.commerce.negotiation.objects.ControlRuleAccessBean controlRuleAccessBean
Instance variable to store a access bean.

ruleName

protected java.lang.String ruleName
Instance variable to store the rule name.
Constructor Detail

ControlRuleListBeanCmdImpl

public ControlRuleListBeanCmdImpl()
Method Detail

getControlRule

public com.ibm.commerce.negotiation.objects.ControlRuleAccessBean getControlRule()
Fetches a ControlRule from the list.
Specified by:
getControlRule in interface ControlRuleListBeanCmd
Returns:
com.ibm.commerce.negotiation.objects.ControlRuleAccessBean

getOwnerId

public java.lang.Long getOwnerId()
Fetches the ownerId used for list population.
Returns:
Long

getRuleName

public java.lang.String getRuleName()
Fetches the control rule name used for list population.
Returns:
java.lang.String

getRuleType

public java.lang.String getRuleType()
Fetches the control rule type used for list population.
Returns:
java.lang.String

isReadyToCallExecute

public boolean isReadyToCallExecute()
Description copied from class: AbstractECTargetableCommand
This method is called by the Targettable Command frame work before the execution of the command. The default implementation is to return true.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
Always returns 'true'.

performExecute

public void performExecute()
                    throws ECException
Populates a list of control rules matching specific criteria, in the following precedence: - by match on both the ownerId and ruleType - by match on both the ownerId and ruleName - by macthing ownerId - a list of all rules
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - This exception is allowed to percolate.

populateDataBeanCommand

public void populateDataBeanCommand(InputDataBean aDataBean)
Get input data (OwnerId, RuleType, or RuleName) from ControlRuleListBean
Overrides:
populateDataBeanCommand in class DataBeanCommandImpl
Parameters:
aDataBean - The ControlRuleListBean

reset

public void reset()
Resets the bean.
Overrides:
reset in class AbstractECTargetableCommand

setControlRule

public void setControlRule(com.ibm.commerce.negotiation.objects.ControlRuleAccessBean newControlRuleAccessBean)
Provides an access bean instance for returning an element from the list.
Parameters:
newControlRuleAccessBean - com.ibm.commerce.negotiation.objects.ControlRuleAccessBean

setOwnerId

public void setOwnerId(java.lang.Long newOwnerId)
Sets the ownerId used by the finder methods to populate the list.
Specified by:
setOwnerId in interface ControlRuleListBeanCmd
Parameters:
newOwnerId - Long

setRequestProperties

public void setRequestProperties(TypedProperty properties)
Obtains command parameters from TypedProperty; current implementation does nothing.
Specified by:
setRequestProperties in interface DataBeanCommand
Overrides:
setRequestProperties in class DataBeanCommandImpl
Parameters:
properties - com.ibm.commerce.datatype.TypedProperty

setRuleName

public void setRuleName(java.lang.String newRuleName)
Sets the rule name used by the finder method to populate the list.
Specified by:
setRuleName in interface ControlRuleListBeanCmd
Parameters:
newRuleName - java.lang.String

setRuleType

public void setRuleType(java.lang.String newRuleType)
Sets the ruleType used by the finder methods to populate the list.
Specified by:
setRuleType in interface ControlRuleListBeanCmd
Parameters:
newRuleType - java.lang.String