com.ibm.commerce.order.calculation
Interface CalculationCodeCombineCmd

All Superinterfaces:
BusinessPolicyCommand, CalculationCmd, TaskCommand
All Known Subinterfaces:
DiscountCalculationCodeCombineCmd, TaxCalculationCodeCombineCmd
All Known Implementing Classes:
CalculationCodeCombineCmdImpl, DiscountCalculationCodeCombineCmdImpl, TaxCalculationCodeCombineCmdImpl

public interface CalculationCodeCombineCmd
extends CalculationCmd

Given a calculation usage and a list of items, this command will determine the calculation codes that are attached to the items. It will return a list of groups (see Group), each containing the following:

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.

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

This is also the base interface that commands registered as calculation methods of type "CalculationCodeCombine" must extend. These commands include:

This command is registered as the following bootstrap calculation methods:

Calculation Method ID Calculation Usage ID Name
-21 -2 CalculationCodeCombine (shipping)
-5001 -5 CalculationCodeCombine (coupon)

Field Summary
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.
 
Method Summary
  Group[] getGroups()
          Returns the groups.
 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
 

Field Detail
public static final java.lang.String COPYRIGHT
The IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation of this command.
See Also:
Constant Field Values
Method Detail

getGroups

public Group[] getGroups()
Returns the groups.
Returns:
the groups.

setItems

public void setItems(Item[] aItems)
Sets the items.
Parameters:
aItems - the items.

setTaxCategoryIds

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