com.ibm.commerce.order.calculation

Class CalculationRuleCombineCmdImpl

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.order.calculation.CalculationCmdImpl

com.ibm.commerce.order.calculation.CalculationRuleCombineCmdImpl

All Implemented Interfaces:

BusinessPolicyCommand, com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, CalculationCmd, CalculationRuleCombineCmd, 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 CalculationRuleCombineCmdImpl
extends CalculationCmdImpl
implements CalculationRuleCombineCmd

The default implementation of CalculationRuleCombineCmd.

Its behaviour is as follows:

1. retrieves the calculation rules of the calculation code.
2. for each calculation rule:
   1. for sales/shipping tax only, ignore this calculation rule if it doesn't belong to the tax categories specified.
   2. if the calculation rule is restricted, invokes the calculation method of type "CalculationRuleQualify" referenced by the calculation rule (see CALRULE.CALMETHOD_ID_QFY, CalculationRuleQualifyCmd) to determine the list of qualified items.
   3. invokes the calculation method of type "CalculationRuleCalculate" referenced by the calculation rule (see CALRULE.CALMETHOD_ID, CalculationRuleQualifyCmd) to calculate its values for the list of qualified items.
3. selects the combination of calculation rules (see CALRULE.COMBINATION) that yields the smallest total value.

Commands used:

• CalculationRuleQualifyCmd
• CalculationRuleCalculateCmd
Access beans used:
• OrderItemAccessBean
• StoreEntityCalculationUsageAccessBean
• CalculationMethodAccessBean
• CalculationCodeAccessBean
• CalculationRuleAccessBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT

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

LOCAL

Fields inherited from interface com.ibm.commerce.order.calculation.CalculationRuleCombineCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CalculationRuleCombineCmdImpl()

Method Summary

Modifier and Type	Method and Description
CalculationRuleAccessBean[]	getRules() getRules method comment.
java.math.BigDecimal[]	getValues(java.lang.Integer anRuleId) getValues method comment.
void	performExecute() This method performs the business logic for this command.
void	reset() This method is called after a command has been executed.
void	setCode(CalculationCodeAccessBean aabCode) Sets the calculation code.
void	setItems(Item[] aItems) Sets the items.
void	setTaxCategoryIds(java.lang.Integer[] anTaxCategoryIds) Sets the tax categories that should be active during execution.

Methods inherited from class com.ibm.commerce.order.calculation.CalculationCmdImpl

getCurrency, getCustomProperties, getCustomProperty, getTimestamp, getUsageId, setCurrency, setCustomProperties, setCustomProperty, setTimestamp, setUsageId

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, 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.order.calculation.CalculationCmd

getCurrency, getCustomProperties, getCustomProperty, getTimestamp, getUsageId, setCurrency, setCustomProperties, setCustomProperty, setTimestamp, setUsageId

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

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

CalculationRuleCombineCmdImpl

public CalculationRuleCombineCmdImpl()

Method Detail

getRules

public CalculationRuleAccessBean[] getRules()

getRules method comment.

Specified by:

getRules in interface CalculationRuleCombineCmd

Returns:

the applicable calculation rules.

getValues

public java.math.BigDecimal[] getValues(java.lang.Integer anRuleId)

getValues method comment.

Specified by:

getValues in interface CalculationRuleCombineCmd

Parameters:

anRuleId - the calculation rule ID.

Returns:

the values of the calculation rules corresponding to the items.

performExecute

public void performExecute()
                    throws ECException

Description copied from class: AbstractECTargetableCommand

This method performs the business logic for this command. This method should be overwritten by all command writers. Command writers should call super.performExecute() as the first line in their method.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

Description copied from class: AbstractECTargetableCommand

This method is called after a command has been executed. It is used to reset its states variables. After the call to reset, the command should be able to be executed again.

Specified by:

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

Overrides:

reset in class CalculationCmdImpl

See Also:

Command.reset()

setCode

public void setCode(CalculationCodeAccessBean aabCode)

Description copied from interface: CalculationRuleCombineCmd

Sets the calculation code.

Specified by:

setCode in interface CalculationRuleCombineCmd

Parameters:

aabCode - the calculation code.

setItems

public void setItems(Item[] aItems)

Description copied from interface: CalculationRuleCombineCmd

Sets the items.

Specified by:

setItems in interface CalculationRuleCombineCmd

Parameters:

aItems - the items.

setTaxCategoryIds

public void setTaxCategoryIds(java.lang.Integer[] anTaxCategoryIds)

Description copied from interface: CalculationRuleCombineCmd

Sets the tax categories that should be active during execution. Normally that would be all sales/shipping tax categories defined in the current store. For sales/shipping tax only.

Specified by:

setTaxCategoryIds in interface CalculationRuleCombineCmd

Parameters:

anTaxCategoryIds - the tax category IDs.