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 databean is used to view the set of Coupons 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
           
 CommandContext commandContext
           
 java.util.Vector couponThumbNails
           
 java.lang.String currency
           
 java.util.Vector discAmts
           
 java.util.Vector itemIds
           
 java.util.Vector itemNames
           
 java.lang.Long orderId
           
 TypedProperty requestProperties
           
 
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 get the CouponIds.
 CommandContext getCommandContext()
          This method gets the command context.
 java.util.Vector getCouponThumbNails()
          This method gets the thumb nail path
 java.lang.String getCurrency()
          This method gets the currency.
 java.util.Vector getDiscAmts()
          Get the discount amounts.
 FormattedMonetaryAmountDataBean getFormattedDiscAmt(java.math.BigDecimal discAmt)
          Get the formatted discount amount.
 java.util.Vector getItemIds()
          Get the itemIds.
 java.util.Vector getItemNames()
          Get the item names.
 java.lang.Long getOrderId()
          Get the order Id.
 TypedProperty getRequestProperties()
          Get the request properties.
 void populate()
          This method is used to populate data bean, that is used to view the set of Coupons that are applicable for the given order.
 void setBcIds(java.util.Vector newBcIds)
          Set the CouponIds.
 void setCommandContext(CommandContext newCommandContext)
          Set the command context.
 void setCouponThumbNails(java.util.Vector newCouponThumbNails)
          Set the coupon thumbnail images.
 void setCurrency(java.lang.String newCurrency)
          Set the currency.
 void setDiscAmts(java.util.Vector newDiscAmts)
          Set the discount amounts.
 void setItemIds(java.util.Vector newItemIds)
          Set the itemIds.
 void setItemNames(java.util.Vector newItemNames)
          Set the item names.
 void setOrderId(java.lang.Long newOrderId)
          Set the orderId.
 void setRequestProperties(TypedProperty newRequestProperties)
          Set the properties of the request parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

bcIds

public java.util.Vector bcIds

commandContext

public CommandContext commandContext

couponThumbNails

public java.util.Vector couponThumbNails

currency

public java.lang.String currency

discAmts

public java.util.Vector discAmts

itemIds

public java.util.Vector itemIds

itemNames

public java.util.Vector itemNames

orderId

public java.lang.Long orderId

requestProperties

public TypedProperty requestProperties
Constructor Detail

ViewApplicableCouponDataBean

public ViewApplicableCouponDataBean()
Method Detail

getBcIds

public java.util.Vector getBcIds()
This method get the CouponIds.
Returns:
The coupon Ids.

getCommandContext

public CommandContext getCommandContext()
This method gets the command context.
Specified by:
getCommandContext in interface SmartDataBean
Returns:
The command context.

getCouponThumbNails

public java.util.Vector getCouponThumbNails()
This method gets the thumb nail path
Returns:
The vector of thumbnail images

getCurrency

public java.lang.String getCurrency()
This method gets the currency.
Returns:
The currency.

getDiscAmts

public java.util.Vector getDiscAmts()
Get the discount amounts.
Returns:
The vector of discount amounts.

getFormattedDiscAmt

public FormattedMonetaryAmountDataBean getFormattedDiscAmt(java.math.BigDecimal discAmt)
                                                    throws ECSystemException
Get the formatted discount amount.
Parameters:
: - The discount amount.
Returns:
The formatted discount amount.
Throws:
: - com.ibm.commerce.exception.ECSystemException.

getItemIds

public java.util.Vector getItemIds()
Get the itemIds.
Returns:
The set of product Ids.

getItemNames

public java.util.Vector getItemNames()
Get the item names.
Returns:
The set of Product names.

getOrderId

public java.lang.Long getOrderId()
Get the order Id.
Returns:
The order Id.

getRequestProperties

public TypedProperty getRequestProperties()
Get the request properties.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
The request property.

populate

public void populate()
              throws java.lang.Exception
This method is used to populate data bean, that is used to view the set of Coupons 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)
Set the CouponIds.
Parameters:
newBcIds - The set of coupon Ids.

setCommandContext

public void setCommandContext(CommandContext newCommandContext)
Set the command context.
Specified by:
setCommandContext in interface SmartDataBean
Parameters:
newCommandContext - The command context.

setCouponThumbNails

public void setCouponThumbNails(java.util.Vector newCouponThumbNails)
Set the coupon thumbnail images.
Parameters:
newCouponThumbNails - The set of thumbnail images.

setCurrency

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

setDiscAmts

public void setDiscAmts(java.util.Vector newDiscAmts)
Set the discount amounts.
Parameters:
newDiscAmts - The vector of discount amounts.

setItemIds

public void setItemIds(java.util.Vector newItemIds)
Set the itemIds.
Parameters:
newItemIds - The vector of product Ids.

setItemNames

public void setItemNames(java.util.Vector newItemNames)
Set the item names.
Parameters:
newItemNames - The vector of product names.

setOrderId

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

setRequestProperties

public void setRequestProperties(TypedProperty newRequestProperties)
Set the properties of the request parameter.
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
newRequestProperties - The request property.