com.ibm.commerce.price.rule.commands.element

Class PriceRuleElementCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.price.rule.commands.element.PriceRuleElementCmdImpl

All Implemented Interfaces:

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

CalculatePriceElementCmdImpl, CatalogConditionElementCmdImpl, ComparisonConditionElementCmdImpl, CoordinatorElementCmdImpl, CustomerConditionElementCmdImpl, DateConditionElementCmdImpl, NestedPriceRuleElementCmdImpl, PriceListConditionElementCmdImpl, PriceListElementCmdImpl, RoundingElementCmdImpl

public class PriceRuleElementCmdImpl
extends com.ibm.websphere.command.CacheableCommandImpl
implements PriceRuleElementCmd

This class should be extended by all price rule element command. For a condition: Optionally implement validateParameters to validate the element during saving price rule. The method checks that all the required data has been provided and is correct. Implement performExecute and put the condition evaluation result into the returned object. The name of the variable to contain the condition evaluation result is returnedObjectCondition. The value of the variable should be type of Boolean. For an action: Optionally implement validateParameters to validate the element during saving price rule. The method checks that all the required data has been provided and is correct.Implement performExecute and put the price calculation result into the returned object. The name of the variable to contain the calculation result is returnedObjectOffers. The value of the variable should be type of MonetaryAmount.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of this class.
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.price.rule.commands.element.PriceRuleElementCmd

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PriceRuleElementCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatentryId() Get catentryId.
java.lang.String	getCurrency() Get currency.
java.lang.String	getElementId() Get elementId.
java.util.Map	getElementParameters() This method gets the parameters.
com.ibm.commerce.price.rule.runtime.objects.PriceRuleObject	getPriceRule() Get priceRule.
java.lang.Double	getQuantity() Get quantity.
java.util.Map	getReturnedObject() Get returned object.
java.util.Map	getRuntimeParametersMap() Get runtime parameters map.
java.lang.String	getUom() Get UOM.
boolean	isReadyToCallExecute() This method returns true.
void	performExecute() This method performs no actions.
void	setCatentryId(java.lang.String newCatentryId) Set the catentryId.
void	setCurrency(java.lang.String newCurrency) Set the currency.
void	setElementId(java.lang.String newElementId) Set the elementId.
void	setElementParameters(java.util.Map newParameters) This method sets the parameters associated with the element.
void	setPriceRule(com.ibm.commerce.price.rule.runtime.objects.PriceRuleObject newPriceRule) Set the priceRule.
void	setQuantity(java.lang.Double newQuantity) Set the quantity.
void	setReturnedObject(java.util.Map newReturnedObject) Set returned object.
void	setRuntimeParametersMap(java.util.Map newRuntimeParametersMap) Set runtime parameters map.
void	setUom(java.lang.String newUom) Set the UOM.
java.util.List	validateParameters(java.util.Map elementParameters) This method performs validations.

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

execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, reset, 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.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

execute, reset

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

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this class.

See Also:

Constant Field Values

Constructor Detail

PriceRuleElementCmdImpl

public PriceRuleElementCmdImpl()

Method Detail

getCatentryId

public java.lang.String getCatentryId()

Get catentryId.

Specified by:

getCatentryId in interface PriceRuleElementCmd

Returns:

The catentryId. This value will be null if no data found.

setCatentryId

public void setCatentryId(java.lang.String newCatentryId)

Set the catentryId.

Specified by:

setCatentryId in interface PriceRuleElementCmd

Parameters:

newCatentryId - The catentryId to set. It can't be null.

getCurrency

public java.lang.String getCurrency()

Get currency.

Specified by:

getCurrency in interface PriceRuleElementCmd

Returns:

The currency. This value will be null if no data found.

setCurrency

public void setCurrency(java.lang.String newCurrency)

Set the currency.

Specified by:

setCurrency in interface PriceRuleElementCmd

Parameters:

newCurrency - The currency to set. It can't be null.

getQuantity

public java.lang.Double getQuantity()

Get quantity.

Specified by:

getQuantity in interface PriceRuleElementCmd

Returns:

The quantity. This value will be null if no data found.

setQuantity

public void setQuantity(java.lang.Double newQuantity)

Set the quantity.

Specified by:

setQuantity in interface PriceRuleElementCmd

Parameters:

newQuantity - The quantity to set. It can't be null.

getUom

public java.lang.String getUom()

Get UOM.

Specified by:

getUom in interface PriceRuleElementCmd

Returns:

The UOM. This value will be null if no data found.

setUom

public void setUom(java.lang.String newUom)

Set the UOM.

Specified by:

setUom in interface PriceRuleElementCmd

Parameters:

newUom - The UOM to set. It can't be null.

getPriceRule

public com.ibm.commerce.price.rule.runtime.objects.PriceRuleObject getPriceRule()

Get priceRule.

Specified by:

getPriceRule in interface PriceRuleElementCmd

Returns:

The priceRule. This value will be null if no data found.

setPriceRule

public void setPriceRule(com.ibm.commerce.price.rule.runtime.objects.PriceRuleObject newPriceRule)

Set the priceRule.

Specified by:

setPriceRule in interface PriceRuleElementCmd

Parameters:

newPriceRule - The priceRule to set. It can't be null.

getElementId

public java.lang.String getElementId()

Get elementId.

Specified by:

getElementId in interface PriceRuleElementCmd

Returns:

The elementId. This value will be null if no data found.

setElementId

public void setElementId(java.lang.String newElementId)

Set the elementId.

Specified by:

setElementId in interface PriceRuleElementCmd

Parameters:

newElementId - The elementId to set. It can't be null.

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method returns true.

Specified by:

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

Specified by:

isReadyToCallExecute in class com.ibm.websphere.command.TargetableCommandImpl

Returns:

This method returns true.This value will not be null.

performExecute

public void performExecute()
                    throws java.lang.Exception

This method performs no actions. Implementations that extend this class need to implement this method.

Specified by:

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

Specified by:

performExecute in class com.ibm.websphere.command.TargetableCommandImpl

Throws:

java.lang.Exception

validateParameters

public java.util.List validateParameters(java.util.Map elementParameters)

This method performs validations. Implementations that extend this class need to implement this method.This value can be null of no errors.

Specified by:

validateParameters in interface PriceRuleElementCmd

Parameters:

elementParameters - The elementParameters to set. It can be null.

Returns:

The validation error list parameters map. It can be null.

setElementParameters

public void setElementParameters(java.util.Map newParameters)

This method sets the parameters associated with the element. The parameters are from the definition of element template along with the data in the PRELEMENTATTR database table.

Specified by:

setElementParameters in interface PriceRuleElementCmd

Parameters:

newParameters - The name value pairs available to the task command implementation. It can't be null.

getRuntimeParametersMap

public java.util.Map getRuntimeParametersMap()

Get runtime parameters map.

Specified by:

getRuntimeParametersMap in interface PriceRuleElementCmd

Returns:

The Runtime parameters map. This value will be null if no data found.

setRuntimeParametersMap

public void setRuntimeParametersMap(java.util.Map newRuntimeParametersMap)

Set runtime parameters map.

Specified by:

setRuntimeParametersMap in interface PriceRuleElementCmd

Parameters:

newRuntimeParametersMap - It can't be null.

getElementParameters

public java.util.Map getElementParameters()

This method gets the parameters.

Specified by:

getElementParameters in interface PriceRuleElementCmd

Returns:

The name value pairs to provide to the task command implementation. This value will be null if no data found.

getReturnedObject

public java.util.Map getReturnedObject()

Get returned object.

Specified by:

getReturnedObject in interface PriceRuleElementCmd

Returns:

The returned object. This value will be null if no data found.

setReturnedObject

public void setReturnedObject(java.util.Map newReturnedObject)

Set returned object.

Specified by:

setReturnedObject in interface PriceRuleElementCmd

Parameters:

newReturnedObject - It can't be null.