com.ibm.commerce.taxation.commands

Class GetDisplayTaxesCmdImpl

  • All Implemented Interfaces:
    com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, GetDisplayTaxesCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
    Direct Known Subclasses:
    GetDisplayVATTaxesCmdImpl

    public class GetDisplayTaxesCmdImpl
extends TaskCommandImpl
implements GetDisplayTaxesCmd
    This is the default implementation of the GetDisplayTaxesCmd Task Command. It can be called by any commands and databeans to set the different categories of tax amounts (for example 
    GST
    , 
    PST
    and so forth) 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: 

    • iCategorizedTaxAmount
      : contains the tax categories' Ids/names and tax amounts. 
    • ihshTaxDescriptionHash
      : contains the tax categories' Ids/names and descriptions.

    If unsuccessful, the two hashtables will be empty.

    See Also:
    Serialized Form

    • Constructor Detail

      • GetDisplayTaxesCmdImpl

        public GetDisplayTaxesCmdImpl()

    • Method Detail

      • reset

        public void reset()
        Resets the command properties. Prepares the command for re-execution.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand

      • getCategorizedTaxAmount

        public java.util.Hashtable getCategorizedTaxAmount()
        Returns the monetary amounts of all tax categories and their names.
        Specified by:
        getCategorizedTaxAmount in interface 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
        Returns:
        The descriptions, names or ids of all tax categories.

      • getTaxRateHash

        public java.util.HashMap getTaxRateHash()
        Gets the rates of all tax categories.
        Specified by:
        getTaxRateHash in interface GetDisplayTaxesCmd
        Returns:
        The rates of all tax categories.

      • setAddressId

        public void setAddressId(java.lang.Long aAddressId)
        Sets the id of the input ship-to address (Optional).
        Specified by:
        setAddressId in interface 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
        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
        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
        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
        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
        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
        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
        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
        Parameters:
        astrUOM - The unit of measure for the product.
Skip navigation links