com.ibm.commerce.order.calculation

Class Item

  • java.lang.Object
    • com.ibm.commerce.order.calculation.Item


  • public class Item
    extends java.lang.Object
    This is an OrderItemAccessBean wrapper.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The IBM copyright notice field
    • Constructor Summary

      Constructors 
      Constructor and Description
      Item(java.lang.Long anCatalogEntryId, java.lang.Long anAddressId, java.lang.Integer anStoreEntityId) 
      Item(java.lang.Long anCatalogEntryId, java.lang.Long anAddressId, java.lang.Integer anStoreEntityId, java.lang.Double adQuantity) 
      Item(java.lang.Long anCatalogEntryId, java.lang.Long anContractId, java.lang.Long anOfferId, java.lang.Long anAddressId, java.lang.Integer anFulfillmentCenterId, java.lang.Integer anShippingModeId, java.math.BigDecimal adPrice, java.math.BigDecimal adQuantity) 
      Item(java.lang.Long anCatalogEntryId, java.lang.Long anContractId, java.lang.Long anOfferId, java.lang.Long anAddressId, java.lang.Integer anFulfillmentCenterId, java.lang.Integer anShippingModeId, java.math.BigDecimal adPrice, java.math.BigDecimal adQuantity, java.lang.Long anComponentParentID) 
      Item(java.lang.Long anCatalogEntryId, java.lang.Long anContractId, java.lang.Long anOfferId, java.lang.Long anAddressId, java.lang.Integer anOrderReleaseNumber, java.lang.Integer anFulfillmentCenterId, java.lang.Integer anShippingModeId, java.math.BigDecimal adPrice, java.math.BigDecimal adQuantity) 
      Item(OrderItemAccessBean aabOrderItem) 
    • Field Detail

      • COPYRIGHT

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

      • Item

        public Item(java.lang.Long anCatalogEntryId,
                    java.lang.Long anAddressId,
                    java.lang.Integer anStoreEntityId)
      • Item

        public Item(java.lang.Long anCatalogEntryId,
                    java.lang.Long anAddressId,
                    java.lang.Integer anStoreEntityId,
                    java.lang.Double adQuantity)
      • Item

        public Item(java.lang.Long anCatalogEntryId,
                    java.lang.Long anContractId,
                    java.lang.Long anOfferId,
                    java.lang.Long anAddressId,
                    java.lang.Integer anFulfillmentCenterId,
                    java.lang.Integer anShippingModeId,
                    java.math.BigDecimal adPrice,
                    java.math.BigDecimal adQuantity)
      • Item

        public Item(java.lang.Long anCatalogEntryId,
                    java.lang.Long anContractId,
                    java.lang.Long anOfferId,
                    java.lang.Long anAddressId,
                    java.lang.Integer anOrderReleaseNumber,
                    java.lang.Integer anFulfillmentCenterId,
                    java.lang.Integer anShippingModeId,
                    java.math.BigDecimal adPrice,
                    java.math.BigDecimal adQuantity)
      • Item

        public Item(java.lang.Long anCatalogEntryId,
                    java.lang.Long anContractId,
                    java.lang.Long anOfferId,
                    java.lang.Long anAddressId,
                    java.lang.Integer anFulfillmentCenterId,
                    java.lang.Integer anShippingModeId,
                    java.math.BigDecimal adPrice,
                    java.math.BigDecimal adQuantity,
                    java.lang.Long anComponentParentID)
    • Method Detail

      • createExceptionData

        public TypedProperty createExceptionData()
      • equals

        public boolean equals(java.lang.Object aObj)
        Overrides:
        equals in class java.lang.Object
      • getAddressId

        public java.lang.Long getAddressId()
      • getAdjustmentTotal

        public java.math.BigDecimal getAdjustmentTotal()
      • getCatalogEntryId

        public java.lang.Long getCatalogEntryId()
      • getContractId

        public java.lang.Long getContractId()
      • getEstimatedAvailableTime

        public java.sql.Timestamp getEstimatedAvailableTime()
      • getFulfillmentCenterId

        public java.lang.Integer getFulfillmentCenterId()
      • getOfferId

        public java.lang.Long getOfferId()
      • getOrderItemId

        public java.lang.Long getOrderItemId()
      • getPrepareFlags

        public java.lang.Integer getPrepareFlags()
      • getPrice

        public java.math.BigDecimal getPrice()
      • getProductTotal

        public java.math.BigDecimal getProductTotal()
      • getQuantity

        public java.math.BigDecimal getQuantity()
      • getSalesTaxTotal

        public java.math.BigDecimal getSalesTaxTotal()
      • getShippingModeId

        public java.lang.Integer getShippingModeId()
      • getShippingOffset

        public java.lang.Integer getShippingOffset()
      • getShippingTaxTotal

        public java.math.BigDecimal getShippingTaxTotal()
      • getShippingTotal

        public java.math.BigDecimal getShippingTotal()
      • getStatus

        public java.lang.String getStatus()
      • getStoreEntityId

        public java.lang.Integer getStoreEntityId()
      • getAdjustmentTotal

        public java.math.BigDecimal getAdjustmentTotal(java.lang.Integer anCalculationUsageId)
                                                throws ECException
        This method is used to get the adjustment total of order item by calculation usage.
        Parameters:
        anCalculationUsageId - the calculation usage id.
        Returns:
        adjustment total
        Throws:
        ECException
      • getAdjustmentTotalByUsage

        public java.util.HashMap getAdjustmentTotalByUsage()
        This method is used to get the adjustment total HashMap
        Returns:
        HashMap of usage and adjustment total
      • setAdjustmentTotalByUsage

        public void setAdjustmentTotalByUsage(java.util.HashMap adjustMap)
        This method is used to set the value of ihshAdjustmentTotals.
        Parameters:
        adjustMap -
      • getTaxableAdjustmentTotal

        public java.math.BigDecimal getTaxableAdjustmentTotal(java.lang.Integer anTaxCategoryId)
                                                       throws ECException
        Throws:
        ECException
      • getTaxableAdjustmentTotals

        public java.util.HashMap getTaxableAdjustmentTotals()
      • getTaxAmount

        public java.math.BigDecimal getTaxAmount(java.lang.Integer anTaxCategoryId)
      • getTaxAmounts

        public java.util.HashMap getTaxAmounts()
      • setAddressId

        public void setAddressId(java.lang.Long anAddressId)
      • setAdjustmentTotal

        public void setAdjustmentTotal(java.math.BigDecimal adAdjustmentTotal)
      • setCatalogEntryId

        public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
      • setContractId

        public void setContractId(java.lang.Long anContractId)
      • setEstimatedAvailableTime

        public void setEstimatedAvailableTime(java.sql.Timestamp aEstimatedAvailableTime)
      • setFulfillmentCenterId

        public void setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)
      • setOfferId

        public void setOfferId(java.lang.Long anOfferId)
      • setPrepareFlags

        public void setPrepareFlags(java.lang.Integer anPrepareFlags)
      • setPrice

        public void setPrice(java.math.BigDecimal adPrice)
      • setProductTotal

        public void setProductTotal(java.math.BigDecimal adProductTotal)
      • setQuantity

        public void setQuantity(java.math.BigDecimal adQuantity)
      • setSalesTaxTotal

        public void setSalesTaxTotal(java.math.BigDecimal adSalesTaxTotal)
      • setShippingModeId

        public void setShippingModeId(java.lang.Integer anShippingModeId)
      • setShippingOffset

        public void setShippingOffset(java.lang.Integer anShippingOffset)
      • setShippingTaxTotal

        public void setShippingTaxTotal(java.math.BigDecimal adShippingTaxTotal)
      • setShippingTotal

        public void setShippingTotal(java.math.BigDecimal adShippingTotal)
      • setStatus

        public void setStatus(java.lang.String astrStatus)
      • setStoreEntityId

        public void setStoreEntityId(java.lang.Integer anStoreEntityId)
      • setTaxableAdjustmentTotal

        public void setTaxableAdjustmentTotal(java.lang.Integer anTaxCategoryId,
                                              java.math.BigDecimal adTaxableAdjustmentTotal)
      • setTaxAmount

        public void setTaxAmount(java.lang.Integer anTaxCategoryId,
                                 java.math.BigDecimal adTaxAmount)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getOrderReleaseNumber

        public java.lang.Integer getOrderReleaseNumber()
        Returns the inOrderReleaseNumber.
        Returns:
        Integer
      • setOrderReleaseNumber

        public void setOrderReleaseNumber(java.lang.Integer newOrderReleaseNumber)
        Sets the inOrderReleaseNumber.
        Parameters:
        newOrderReleaseNumber - The inOrderReleaseNumber to set
      • getTotalTaxRate

        public java.math.BigDecimal getTotalTaxRate()
        Gets the Total Tax Rate for this Order Item
        Returns:
        total tax rate
      • setTotalTaxRate

        public void setTotalTaxRate(java.math.BigDecimal decimal)
        Sets the Total Tax Rate for this Order Item. This field is not persisted in the database
        Parameters:
        decimal -
      • getTaxRate

        public java.math.BigDecimal getTaxRate(java.lang.String jursidiction)
        Obtains the tax rate calculated for a given type of jurisdiction level..

        Parameters:
        jursidiction - the type of jurisdiction level. Accepted types can be "COUNTRY", "TERRITORY", "STATE", "COUNTY", "CITY" and "DISTRICT".

        Returns:
        The tax rate calculated for the given type of jurisdiction level.
      • setTaxRate

        public void setTaxRate(java.lang.String jursidiction,
                               java.math.BigDecimal taxRate)
        Set the tax calculated for a given type of jurisdiction level. This field is not persisted in the database

        Parameters:
        jursidiction - the type of jurisdiction level. Accepted types can be "COUNTRY", "TERRITORY", "STATE", "COUNTY", "CITY" and "DISTRICT".
        taxRate - the Tax Rate that corresponds to the jurisdiction type

      • getSecondaryTaxRate

        public java.math.BigDecimal getSecondaryTaxRate(java.lang.String jursidiction)
        Obtains the tax rate calculated for a given type of secondary jurisdiction level..

        Parameters:
        jursidiction - the type of secondary jurisdiction level. Accepted types can be "SECONDARYSTATE", "SECONARYCOUNTY", "SECONDARYCITY".

        Returns:
        The tax rate calculated for the given type of secondary jurisdiction level.
      • setSecondaryTaxRate

        public void setSecondaryTaxRate(java.lang.String jursidiction,
                                        java.math.BigDecimal taxRate)
        Set the tax calculated for a given type of jurisdiction level. This field is not persisted in the database

        Parameters:
        jursidiction - the type of jurisdiction level. Accepted types can be "SECONDARYSTATE", "SECONARYCOUNTY", "SECONDARYCITY".
        taxRate - the Tax Rate that corresponds to the jurisdiction type

      • getRecyclingFee

        public java.math.BigDecimal getRecyclingFee()
        Gets the Recycling Fee for this Order Item
        Returns:
        Recycling Fee
      • setRecyclingFee

        public void setRecyclingFee(java.math.BigDecimal decimal)
        Sets the Recycling Fee for this Order Item. This field is not persisted in the database
        Parameters:
        decimal -
      • getComponentParentID

        public java.lang.Long getComponentParentID()
        This values is used when an item is a component. This value is the OrderItemID for the parent orderitem for this component. The value returned will be null unless this Item is a component of a kit.
        Returns:
        Long the OrderItem ID of the component parent object