com.ibm.commerce.order.calculation
Class ApplyShippingCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                    |
                    +--com.ibm.commerce.order.calculation.CalculationCmdImpl
                          |
                          +--com.ibm.commerce.order.calculation.ApplyShippingCmdImpl
All Implemented Interfaces:
ApplyCalculationUsageCmd, ApplyShippingCmd, BusinessPolicyCommand, CalculationCmd, ECCommand, TaskCommand

public class ApplyShippingCmdImpl
extends CalculationCmdImpl
implements ApplyShippingCmd

This is the default implementation of the ApplyShipping command.

See Also:
ApplyShippingCmd

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.order.calculation.ApplyShippingCmd
defaultCommandClassName, NAME
 
Constructor Summary
ApplyShippingCmdImpl()
           
 
Method Summary
protected  void callApplyCalculationUsage(java.lang.Long anPolicyId, Item[] aItems)
          This method is called by performExecute() to invoke the implementation of the ApplyCalculationUsage command of a particular shipping charge policy.
 void checkAppliedItems()
          This method checks whether the calculation usage is applied to all items.
 java.util.Set getAppliedItems()
          Returns the set of items that have been applied to.
protected  java.lang.Long getPolicyId(java.lang.Long anTradingId)
          This method is called by performExecute() to identify the shipping charge policy referenced by a particular trading agreement.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 void reset()
          This method is called after a command has been executed to reset its states variables.
 void setItems(Item[] aItems)
          Sets the items.
 void setTaxCategoryIds(java.lang.Integer[] anTaxCategoryIds)
          Sets the tax categories.
 
Methods inherited from class com.ibm.commerce.order.calculation.CalculationCmdImpl
createCommand, 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.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, 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.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

ApplyShippingCmdImpl

public ApplyShippingCmdImpl()
Method Detail

callApplyCalculationUsage

protected void callApplyCalculationUsage(java.lang.Long anPolicyId,
                                         Item[] aItems)
                                  throws ECException
This method is called by performExecute() to invoke the implementation of the ApplyCalculationUsage command of a particular shipping charge policy.

checkAppliedItems

public void checkAppliedItems()
                       throws ECException
Description copied from interface: ApplyCalculationUsageCmd
This method checks whether the calculation usage is applied to all items. If not, an _ERR_CALCODE ECApplicationException will be thrown.
Specified by:
checkAppliedItems in interface ApplyCalculationUsageCmd

getAppliedItems

public java.util.Set getAppliedItems()
Description copied from interface: ApplyCalculationUsageCmd
Returns the set of items that have been applied to.
Specified by:
getAppliedItems in interface ApplyCalculationUsageCmd

getPolicyId

protected java.lang.Long getPolicyId(java.lang.Long anTradingId)
                              throws ECException
This method is called by performExecute() to identify the shipping charge policy referenced by a particular trading agreement.

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reset

public void reset()
Description copied from class: AbstractECCommand
This method is called after a command has been executed to reset its states variables. After the call to reset, we should be able to execute the command again.
Overrides:
reset in class CalculationCmdImpl

setItems

public void setItems(Item[] aItems)
Description copied from interface: ApplyCalculationUsageCmd
Sets the items.
Specified by:
setItems in interface ApplyCalculationUsageCmd

setTaxCategoryIds

public void setTaxCategoryIds(java.lang.Integer[] anTaxCategoryIds)
Description copied from interface: ApplyCalculationUsageCmd
Sets the tax categories. They should be set to:
Calculation Usage Tax Categories
sales tax all sales tax categories
shipping tax all shipping tax categories
other null
Specified by:
setTaxCategoryIds in interface ApplyCalculationUsageCmd