com.ibm.commerce.order.calculation

Interface CalculationRuleCombineCmd

All Superinterfaces:

BusinessPolicyCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, CalculationCmd, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Subinterfaces:

VATCalculationRuleCombineCmd

All Known Implementing Classes:

CalculationRuleCombineCmdImpl, VATCalculationRuleCombineCmdImpl

public interface CalculationRuleCombineCmd
extends CalculationCmd

Sets a calculation code and a list of items first. This command will determine the calculation rules that are applicable to the items and calculate the values of these calculation rules.

For sales/shipping tax only, the caller has to specify the tax categories that should be active during execution. Normally that would be all sales/shipping tax categories defined in the current store. This command will ignore calculation rules that don't belong to these tax categories.

For more information, refer to the default implementation of this command, CalculationRuleCombineCmdImpl.

This is also the base interface that commands registered as calculation methods of type "CalculationRuleCombine" must extend.

This command is registered as the following bootstrap calculation methods:

Calculation Method ID	Calculation Usage ID	Name
-5	-1	CalculationRuleCombine (discount)
-25	-2	CalculationRuleCombine (shipping)
-45	-3	CalculationRuleCombine (sales tax)
-65	-4	CalculationRuleCombine (shipping tax)
-5005	-5	CalculationRuleCombine (coupon)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of this command.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
CalculationRuleAccessBean[]	getRules() Returns the applicable calculation rules.
java.math.BigDecimal[]	getValues(java.lang.Integer anRuleId) Returns the values of a calculation rule corresponding to the items.
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 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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute, reset

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

Method Detail

getRules

CalculationRuleAccessBean[] getRules()

Returns the applicable calculation rules.

Returns:

the applicable calculation rules.

getValues

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

Returns the values of a calculation rule corresponding to the items.

Parameters:

anRuleId - the calculation rule ID.

Returns:

the values of the calculation rules corresponding to the items.

setCode

void setCode(CalculationCodeAccessBean aabCode)

Sets the calculation code.

Parameters:

aabCode - the calculation code.

setItems

void setItems(Item[] aItems)

Sets the items.

Parameters:

aItems - the items.

setTaxCategoryIds

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

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.

Parameters:

anTaxCategoryIds - the tax category IDs.