com.ibm.commerce.order.calculation

Class CalculationRuleCalculateCmdImpl

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

All Implemented Interfaces:

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

The default implementation of CalculationRuleCalculateCmd.

Its behaviour is as follows:

1. identifies the calculation scales associated with the calculation rule (see CRULESCALE).
2. groups the calculation scales by currency (see CALSCALE.SETCCURR).
3. if there are ones in the currency specified, discards the others.
4. for each calculation scale, calculates its values:
   1. invokes the calculation method of type "CalculationScaleLookup" referenced by the calculation scale (see CALSCALE.CALMETHOD_ID, CalculationScaleLookupCmd) to determine the following:
      • a lookup number.
      • a base monetary value.
      • a result multiplier.
      • a mathematical weight for each item.
   2. identifies the calculation ranges of the calculation scale where (range start <= lookup number).
   3. for each calculation range, in descending order of range start:
      1. determines the applicable lookup number. It is (max(lookup number, range end) - range start) if the calculation range is cumulative (see CALRANGE.CUMULATIVE). Or max(lookup number, range end) if not.
      2. invokes the calculation method of type "CalculationRange" referenced by the calculation range (see CALRANGE.CALMETHOD_ID, CalculationRangeCmd) to calculate the resulting value.
      3. multiplies this value by the result multiplier.
      4. adds this value to a total value.
      5. breaks if the calculation range is not cumulative.
   4. distributes the total value among the items based on their mathematical weights.
   5. applies the direct attachments associated with the calculation rule.
5. for each group of calculation scales, merges the lists of resulting values.
6. select the merged list that has the lowest total value.

Commands used:

• CalculationRuleCombineCmd

Access beans used:

• OrderItemAccessBean
• CalculationMethodAccessBean
• CalculationCodeAccessBean
• CalculationRuleAccessBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.

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

LOCAL

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

defaultCommandClassName, FILTER_SCALES_BY_STORE, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CalculationRuleCalculateCmdImpl() Constructor for CalculationRuleCalculateCmdImpl.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal[]	getValues() Returns the values corresponding to the items.
void	performExecute() This method performs the business logic for this command.
void	reset() Resets the command properties.
void	setItems(Item[] aItems) Sets the items.
void	setRule(CalculationRuleAccessBean aabRule) Sets the calculation rule.

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

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

CalculationRuleCalculateCmdImpl

public CalculationRuleCalculateCmdImpl()

Constructor for CalculationRuleCalculateCmdImpl.

Method Detail

reset

public void reset()

Resets the command properties. Prepares the command for re-execution.

Specified by:

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

Overrides:

reset in class CalculationCmdImpl

See Also:

Command.reset()

getValues

public java.math.BigDecimal[] getValues()

Returns the values corresponding to the items.

Specified by:

getValues in interface CalculationRuleCalculateCmd

Returns:

the values.

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

See Also:

ECCommand.performExecute()

setItems

public void setItems(Item[] aItems)

Sets the items.

Specified by:

setItems in interface CalculationRuleCalculateCmd

Parameters:

aItems - the items.

setRule

public void setRule(CalculationRuleAccessBean aabRule)

Sets the calculation rule.

Specified by:

setRule in interface CalculationRuleCalculateCmd

Parameters:

aabRule - the calculation rule.