com.ibm.commerce.negotiation.bean.commands

Class ControlRuleListBeanCmdImpl

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

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

All Implemented Interfaces:

DataBeanCommand, ECCommand, ECTargetableCommand, com.ibm.commerce.command.TargetableECCommand, ControlRuleListBeanCmd, 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

public class ControlRuleListBeanCmdImpl
extends DataBeanCommandImpl
implements ControlRuleListBeanCmd

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

• ControlRuleAccessBean

This command uses the following DataBeans:

• InputDataBean
• ControlRuleDataBean
• ControlRuleListBean

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

emptyString, EURO_CODE

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

LOCAL

Fields inherited from interface com.ibm.commerce.negotiation.bean.commands.ControlRuleListBeanCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.commerce.command.TargetableECCommand

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ControlRuleListBeanCmdImpl()

Method Summary

Modifier and Type	Method and Description
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 targetable command framework.
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 matching ownerId - a list of all rules
void	populateDataBeanCommand(InputDataBean aDataBean) Gets input data (OwnerId, RuleType, or RuleName) from ControlRuleListBean
void	reset() Resets the bean.
void	setControlRule(ControlRuleAccessBean newControlRuleAccessBean) Provides an access bean instance for returning an element from the list.
void	setOwnerId(java.lang.Long newOwnerId) Sets the owner ID 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 rule type used by the finder methods to populate the list.

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

getDataBean, setDataBean

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

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

execute

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

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

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, validateParameters

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

unionDependencies

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ControlRuleListBeanCmdImpl

public ControlRuleListBeanCmdImpl()

Method Detail

getControlRule

public 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 targetable command framework. This is where client side parameter checking is performed (before the execution of the command). The default implementation is to return true.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

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 matching ownerId - a list of all rules

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - This exception is allowed to percolate.

populateDataBeanCommand

public void populateDataBeanCommand(InputDataBean aDataBean)

Gets input data (OwnerId, RuleType, or RuleName) from ControlRuleListBean

Overrides:

populateDataBeanCommand in class DataBeanCommandImpl

Parameters:

aDataBean - The ControlRuleListBean

reset

public void reset()

Resets the bean.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setControlRule

public void setControlRule(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 owner ID 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 rule type used by the finder methods to populate the list.

Specified by:

setRuleType in interface ControlRuleListBeanCmd

Parameters:

newRuleType - java.lang.String