com.ibm.commerce.couponredemption.databeans

Class ViewApplicableCouponDataBean

  • java.lang.Object
    • com.ibm.commerce.couponredemption.databeans.ViewApplicableCouponDataBean
  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, ViewApplicableCouponInputDataBean, java.io.Serializable

    Deprecated. 
    The WC54 coupon feature will be replaced by the WC56 promotion engine coupon feature.

    public class ViewApplicableCouponDataBean
    extends java.lang.Object
    implements SmartDataBean, ViewApplicableCouponInputDataBean
    This data bean is used to view the set of eCoupons that are applicable for the given order.

    The input parameter for this data bean is :

    • orderId: Long

    This can be queried for the following :

    • orderId: Long
    • bcIds: Vector
    • itemIds: Vector
    • discAmts: Vector
    • couponThumbNails: Vector
    • itemNames: Vector
    • currency: String
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      java.util.Vector bcIds
      Deprecated. 
      Coupons that are applicable to the order being considered.
      CommandContext commandContext
      Deprecated. 
      The command context.
      java.util.Vector couponThumbNails
      Deprecated. 
      The nth element of this vector is the path of the thumbnail image for the nth coupon.
      java.lang.String currency
      Deprecated. 
      The currency used in this order.
      java.util.Vector discAmts
      Deprecated. 
      The nth element of this vector is a vector of discount amounts on the items that the nth coupon applies to.
      java.util.Vector itemIds
      Deprecated. 
      The nth element of this vector is a vector of item IDs that the nth coupon applies to.
      java.util.Vector itemNames
      Deprecated. 
      The nth element of this vector is a vector of item names that the nth coupon applies to.
      java.lang.Long orderId
      Deprecated. 
      The order for which the applicable coupons are being viewed.
      TypedProperty requestProperties
      Deprecated. 
      The request properties.
    • Field Detail

      • requestProperties

        public TypedProperty requestProperties
        Deprecated. 
        The request properties.
      • commandContext

        public CommandContext commandContext
        Deprecated. 
        The command context.
      • orderId

        public java.lang.Long orderId
        Deprecated. 
        The order for which the applicable coupons are being viewed.
      • bcIds

        public java.util.Vector bcIds
        Deprecated. 
        Coupons that are applicable to the order being considered.
      • itemIds

        public java.util.Vector itemIds
        Deprecated. 
        The nth element of this vector is a vector of item IDs that the nth coupon applies to.
      • discAmts

        public java.util.Vector discAmts
        Deprecated. 
        The nth element of this vector is a vector of discount amounts on the items that the nth coupon applies to.
      • couponThumbNails

        public java.util.Vector couponThumbNails
        Deprecated. 
        The nth element of this vector is the path of the thumbnail image for the nth coupon.
      • itemNames

        public java.util.Vector itemNames
        Deprecated. 
        The nth element of this vector is a vector of item names that the nth coupon applies to.
      • currency

        public java.lang.String currency
        Deprecated. 
        The currency used in this order.
    • Constructor Detail

      • ViewApplicableCouponDataBean

        public ViewApplicableCouponDataBean()
        Deprecated. 
    • Method Detail

      • getBcIds

        public java.util.Vector getBcIds()
        Deprecated. 
        This method gets the eCouponIds.
        Returns:
        java.lang.Long
      • getCouponThumbNails

        public java.util.Vector getCouponThumbNails()
        Deprecated. 
        Gets the coupon thumbnail image paths.
        Returns:
        java.util.Vector
      • getCurrency

        public java.lang.String getCurrency()
        Deprecated. 
        Gets the currency.
        Returns:
        java.lang.String
      • getDiscAmts

        public java.util.Vector getDiscAmts()
        Deprecated. 
        Gets the discount amounts.
        Returns:
        java.util.Vector
      • getFormattedDiscAmt

        public FormattedMonetaryAmountDataBean getFormattedDiscAmt(java.math.BigDecimal discAmt)
                                                            throws ECSystemException
        Deprecated. 
        Gets the formatted discount amount.
        Parameters:
        discAmt - The amount to be formatted.
        Returns:
        com.ibm.commerce.price.beans.FormattedMonetaryAmountDataBean
        Throws:
        com.ibm.commerce.exception.ECSystemException.
        ECSystemException
      • getItemIds

        public java.util.Vector getItemIds()
        Deprecated. 
        Gets the itemIds.
        Returns:
        java.util.Vector
      • getItemNames

        public java.util.Vector getItemNames()
        Deprecated. 
        Gets the item names.
        Returns:
        java.util.Vector
      • getOrderId

        public java.lang.Long getOrderId()
        Deprecated. 
        Gets the orderId.
        Returns:
        java.lang.Long
      • populate

        public void populate()
                      throws java.lang.Exception
        Deprecated. 
        This method populates data bean with the set of eCoupons that are applicable for the given order.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception
      • setBcIds

        public void setBcIds(java.util.Vector newBcIds)
        Deprecated. 
        Sets the eCouponIds.
        Parameters:
        newBcIds - java.lang.Long
      • setCommandContext

        public void setCommandContext(CommandContext newCommandContext)
        Deprecated. 
        Sets the command context.
        Specified by:
        setCommandContext in interface SmartDataBean
        Parameters:
        newCommandContext - com.ibm.commerce.command.CommandContext
      • setCouponThumbNails

        public void setCouponThumbNails(java.util.Vector newCouponThumbNails)
        Deprecated. 
        Sets the thumbnail image paths for the coupons.
        Parameters:
        newCouponThumbNails - java.util.Vector
      • setCurrency

        public void setCurrency(java.lang.String newCurrency)
        Deprecated. 
        Sets the currency.
        Parameters:
        newCurrency - java.lang.String
      • setDiscAmts

        public void setDiscAmts(java.util.Vector newDiscAmts)
        Deprecated. 
        Sets the discount amounts.
        Parameters:
        newDiscAmts - java.util.Vector
      • setItemIds

        public void setItemIds(java.util.Vector newItemIds)
        Deprecated. 
        Sets the itemIds.
        Parameters:
        newItemIds - java.util.Vector
      • setItemNames

        public void setItemNames(java.util.Vector newItemNames)
        Deprecated. 
        Sets the item names.
        Parameters:
        newItemNames - java.util.Vector
      • setRequestProperties

        public void setRequestProperties(TypedProperty newRequestProperties)
        Deprecated. 
        Sets the request properties.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        newRequestProperties - com.ibm.commerce.datatype.TypedProperty