com.ibm.commerce.couponredemption.databeans
Class ViewApplicableCouponDataBean

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

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 :

This can be queried for the following :

See Also:
Serialized Form

Field Summary
 java.util.Vector bcIds
          Coupons that are applicable to the order being considered.
  CommandContext commandContext
          The command context.
 java.util.Vector couponThumbNails
          The nth element of this vector is the path of the thumbnail image for the nth coupon.
 java.lang.String currency
          The currency used in this order.
 java.util.Vector discAmts
          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
          The nth element of this vector is a vector of item IDs that the nth coupon applies to.
 java.util.Vector itemNames
          The nth element of this vector is a vector of item names that the nth coupon applies to.
 java.lang.Long orderId
          The order for which the applicable coupons are being viewed.
  TypedProperty requestProperties
          The request properties.
 
Fields inherited from interface com.ibm.commerce.beans. SmartDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Fields inherited from interface com.ibm.commerce.couponredemption.databeans. ViewApplicableCouponInputDataBean
COPYRIGHT
 
Constructor Summary
ViewApplicableCouponDataBean()
           
 
Method Summary
 java.util.Vector getBcIds()
          This method gets the eCouponIds.
  CommandContext getCommandContext()
          Gets the command context.
 java.util.Vector getCouponThumbNails()
          Gets the coupon thumbnail image paths.
 java.lang.String getCurrency()
          Gets the currency.
 java.util.Vector getDiscAmts()
          Gets the discount amounts.
  FormattedMonetaryAmountDataBean getFormattedDiscAmt(java.math.BigDecimal discAmt)
          Gets the formatted discount amount.
 java.util.Vector getItemIds()
          Gets the itemIds.
 java.util.Vector getItemNames()
          Gets the item names.
 java.lang.Long getOrderId()
          Gets the orderId.
  TypedProperty getRequestProperties()
          Gets the request properties.
 void populate()
          This method populates data bean with the set of eCoupons that are applicable for the given order.
 void setBcIds(java.util.Vector newBcIds)
          Sets the eCouponIds.
 void setCommandContext( CommandContext newCommandContext)
          Sets the command context.
 void setCouponThumbNails(java.util.Vector newCouponThumbNails)
          Sets the thumbnail image paths for the coupons.
 void setCurrency(java.lang.String newCurrency)
          Sets the currency.
 void setDiscAmts(java.util.Vector newDiscAmts)
          Sets the discount amounts.
 void setItemIds(java.util.Vector newItemIds)
          Sets the itemIds.
 void setItemNames(java.util.Vector newItemNames)
          Sets the item names.
 void setOrderId(java.lang.Long newOrderId)
          Sets the orderId.
 void setRequestProperties( TypedProperty newRequestProperties)
          Sets the request properties.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

requestProperties

public TypedProperty requestProperties
The request properties.

commandContext

public CommandContext commandContext
The command context.

orderId

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

bcIds

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

itemIds

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

discAmts

public java.util.Vector discAmts
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
The nth element of this vector is the path of the thumbnail image for the nth coupon.

itemNames

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

currency

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

ViewApplicableCouponDataBean

public ViewApplicableCouponDataBean()
Method Detail

getBcIds

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

getCommandContext

public CommandContext getCommandContext()
Gets the command context.
Specified by:
getCommandContext in interface SmartDataBean
Returns:
com.ibm.commerce.command.CommandContext

getCouponThumbNails

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

getCurrency

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

getDiscAmts

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

getFormattedDiscAmt

public FormattedMonetaryAmountDataBean getFormattedDiscAmt(java.math.BigDecimal discAmt)
                                                    throws ECSystemException
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()
Gets the itemIds.
Returns:
java.util.Vector

getItemNames

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

getOrderId

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

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request properties.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
com.ibm.commerce.datatype.TypedProperty

populate

public void populate()
              throws java.lang.Exception
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)
Sets the eCouponIds.
Parameters:
newBcIds - java.lang.Long

setCommandContext

public void setCommandContext(CommandContext newCommandContext)
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)
Sets the thumbnail image paths for the coupons.
Parameters:
newCouponThumbNails - java.util.Vector

setCurrency

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

setDiscAmts

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

setItemIds

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

setItemNames

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

setOrderId

public void setOrderId(java.lang.Long newOrderId)
Sets the orderId.
Specified by:
setOrderId in interface ViewApplicableCouponInputDataBean
Parameters:
newOrderId - java.lang.Long

setRequestProperties

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