com.ibm.commerce.taxation.commands
Class GetDisplayTaxesCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.taxation.commands.GetDisplayTaxesCmdImpl
All Implemented Interfaces:
ECCommand, GetDisplayTaxesCmd, TaskCommand

public class GetDisplayTaxesCmdImpl
extends TaskCommandImpl
implements GetDisplayTaxesCmd

The GetDisplayTaxesCmd Task Command default Implementation can be called by any commands and databeans to set the different categories of tax amounts (e.g. GST, PST etc.) for the input catalog entry. It uses CalculationCodes with calculationUsage of Taxation to calculate the tax amounts for each of the tax categories that have been marked for display.

If the command is successful, it will populate two hashtables:

If unsuccessful, the two hashtables will be empty.


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
defaultCommandClassName, NAME
 
Constructor Summary
GetDisplayTaxesCmdImpl()
           
 
Method Summary
 java.util.Hashtable getCategorizedTaxAmount()
          Returns the monetary amounts of all tax categories and their names.
 java.util.Hashtable getTaxDescriptionHash()
          Gets the descriptions of all tax categories.
 void performExecute()
          Executes main business logic of the command.
 void setAddressId(java.lang.Long aAddressId)
          Sets the id of the input ship-to address (Optional).
 void setCatEntryId(java.lang.Long aCatEntryId)
          Sets the id of the input catalog entry.
 void setCurrency(java.lang.String aCurrency)
          Sets the currency of the input price amount.
 void setDisplayOnly(boolean abDisplayOnly)
          Sets the flag to indicate if the taxes are calculated for display purpose (Optional).
 void setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId)
          Sets the id of the fulfillment center (Optional).
 void setPrice(java.math.BigDecimal aPrice)
          Sets the product price for calculating the taxes.
 void setQuantity(java.lang.Double aQuantity)
          Sets the product quantity for calculating the taxes.
 void setShippingCharge(java.math.BigDecimal aShippingCharge)
          Sets the shipping charge for the shipping the product.
 void setUOM(java.lang.String astrUOM)
          Sets the unit of measure for the product.
 void validateParameters()
          Checks mandatory parameters.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

GetDisplayTaxesCmdImpl

public GetDisplayTaxesCmdImpl()
Method Detail

getCategorizedTaxAmount

public java.util.Hashtable getCategorizedTaxAmount()
Returns the monetary amounts of all tax categories and their names.
Specified by:
getCategorizedTaxAmount in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Returns:
The monetary amounts of all tax categories and their corresponding category names/ids.

getTaxDescriptionHash

public java.util.Hashtable getTaxDescriptionHash()
Gets the descriptions of all tax categories.
Specified by:
getTaxDescriptionHash in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Returns:
The descriptions, names or ids of all tax categories.

performExecute

public void performExecute()
                    throws ECException
Executes main business logic of the command.
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.

setAddressId

public void setAddressId(java.lang.Long aAddressId)
Sets the id of the input ship-to address (Optional).
Specified by:
setAddressId in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aAddressId - The reference number of the ship-to address.

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)
Sets the id of the input catalog entry.
Specified by:
setCatEntryId in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aCatEntryId - The reference number of the catalog entry.

setCurrency

public void setCurrency(java.lang.String aCurrency)
Sets the currency of the input price amount.
Specified by:
setCurrency in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aCurrency - The currency of the input price amount.

setDisplayOnly

public void setDisplayOnly(boolean abDisplayOnly)
Sets the flag to indicate if the taxes are calculated for display purpose (Optional).
Specified by:
setDisplayOnly in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
abDisplayOnly - To indicate if it is for display use only. A true value (default) means for display. A false value means not for display.

setFulfillmentCenterId

public void setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId)
Sets the id of the fulfillment center (Optional).
Specified by:
setFulfillmentCenterId in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aFulfillmentCenterId - The reference number of the fulfillment center.

setPrice

public void setPrice(java.math.BigDecimal aPrice)
Sets the product price for calculating the taxes.
Specified by:
setPrice in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aPrice - The product price for calculating the taxes.

setQuantity

public void setQuantity(java.lang.Double aQuantity)
Sets the product quantity for calculating the taxes.
Specified by:
setQuantity in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aQuantity - The product quantity for calculating the taxes.

setShippingCharge

public void setShippingCharge(java.math.BigDecimal aShippingCharge)
Sets the shipping charge for the shipping the product.
Specified by:
setShippingCharge in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
aShippingCharge - The product shipping charge.

setUOM

public void setUOM(java.lang.String astrUOM)
Sets the unit of measure for the product.
Specified by:
setUOM in interface GetDisplayTaxesCmd
Following copied from interface: com.ibm.commerce.taxation.commands.GetDisplayTaxesCmd
Parameters:
astrUOM - The unit of measure for the product.

validateParameters

public void validateParameters()
                        throws ECException
Checks mandatory parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -