com.ibm.commerce.marketing.databeans

Class CouponListByOrderDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.marketing.databeans.CouponListByOrderDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, java.io.Serializable

public class CouponListByOrderDataBean
extends SmartDataBeanImpl
implements Delegator

This databean lists all the coupons used in the Order.

Before invoking the populate method on this bean, you must invoke the setOrderId method.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
CouponListByOrderDataBean() Constructor

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.marketing.promotion.coupon.Coupon[]	getCoupons() Returns a list of coupons.
Protectable	getDelegate() Returns the order data bean with the order id set.
void	populate() Loads data into the databean when the DataBeanmanager.activate() runs.
void	setCommandContext(CommandContext cc) Sets the command context associated with the data bean.
void	setOrderId(java.lang.Long anOrderId) Sets the order ID.
void	setRequestProperties(TypedProperty param) Sets the request properties associated with the data bean.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties

Constructor Detail

CouponListByOrderDataBean

public CouponListByOrderDataBean()

Constructor

Method Detail

setCommandContext

public void setCommandContext(CommandContext cc)

Sets the command context associated with the data bean. This is called by the DataBeanManager during the activate method.

Specified by:

setCommandContext in interface SmartDataBean

Overrides:

setCommandContext in class SmartDataBeanImpl

Parameters:

cc - The command context passed to the JSP page that invokes this data bean.

setRequestProperties

public void setRequestProperties(TypedProperty param)

Sets the request properties associated with the data bean. This is called by the DataBeanManager during the activate method.

Specified by:

setRequestProperties in interface InputDataBean

Overrides:

setRequestProperties in class InputDataBeanImpl

Parameters:

param - The set of properties passed to the JSP page that invokes this data bean.

setOrderId

public void setOrderId(java.lang.Long anOrderId)

Sets the order ID.

Parameters:

anOrderId - The order ID.

populate

public void populate()
              throws java.lang.Exception

Loads data into the databean when the DataBeanmanager.activate() runs.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

Throws:

java.lang.Exception - when an error is encountered.

See Also:

SmartDataBean.populate()

getCoupons

public com.ibm.commerce.marketing.promotion.coupon.Coupon[] getCoupons()

Returns a list of coupons.

Returns:

A list of coupons

getDelegate

public Protectable getDelegate()
                        throws java.lang.Exception

Returns the order data bean with the order id set.

Specified by:

getDelegate in interface Delegator

Returns:

the order data bean.

Throws:

java.lang.Exception - when an error is encountered on getting the order data bean.

See Also:

Delegator.getDelegate()