CalculationCodeApplyCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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:

DiscountCalculationCodeApplyCmd, SalesTaxCalculationCodeApplyCmd, ShippingCalculationCodeApplyCmd, ShippingTaxCalculationCodeApplyCmd

All Known Implementing Classes:

DiscountCalculationCodeApplyCmdImpl, SalesTaxCalculationCodeApplyCmdImpl, ShippingCalculationCodeApplyCmdImpl, ShippingTaxCalculationCodeApplyCmdImpl, TaxCalculationCodeApplyCmdImpl
```
public interface CalculationCodeApplyCmd
extends CalculationCmd
```
Sets a calculation code, a list of items and a corresponding list of values. Commands that extend this interface will apply each value to its corresponding item.
For sales/shipping tax only, the caller can specify a list of values for each sales/shipping tax category defined in the current store.

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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.

static java.lang.String NAME
The name of this interface.
- Fields inherited from interface com.ibm.commerce.command.CacheableECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`setCode(CalculationCodeAccessBean aabCode)` Sets the calculation code.
`void`	`setItems(Item[] aItems)` Sets the items.
`void`	`setValues(java.math.BigDecimal[] adValues)` Sets the values to apply.
`void`	`setValues(java.lang.Integer anTaxCategoryId, java.math.BigDecimal[] adValues)` Sets values to apply for a tax category.

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 interface.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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.
  - setValues
```
void setValues(java.math.BigDecimal[] adValues)
```
    Sets the values to apply.
    
    Parameters:
    
    adValues - the values.
  - setValues
```
void setValues(java.lang.Integer anTaxCategoryId,
               java.math.BigDecimal[] adValues)
```
    Sets values to apply for a tax category. For sales/shipping tax only.
    
    Parameters:
    
    anTaxCategoryId - the tax category ID.
    
    adValues - the values.