com.ibm.commerce.marketing.databeans

Class PromoCodeListDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.marketing.databeans.PromoCodeListDataBean

All Implemented Interfaces:

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

public class PromoCodeListDataBean
extends SmartDataBeanImpl
implements Delegator

This method lists all the promotion codes applied for this Order.

Before invoking the populate method, 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
PromoCodeListDataBean() Constructor

Method Summary

Modifier and Type	Method and Description
PromotionCodeData[]	getCodes() Returns the promotion code constructs.
Protectable	getDelegate() Returns the order data bean with the order id set.
java.lang.String[]	getPromoCodes() Deprecated. please use getCodes instead
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 aOrderId) 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

PromoCodeListDataBean

public PromoCodeListDataBean()

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 aOrderId)

Sets the order ID.

Parameters:

aOrderId - The new order ID.

getPromoCodes

public java.lang.String[] getPromoCodes()

Deprecated. please use getCodes instead

Returns a list of retrieved promotion codes for the current order.

Returns:

A list of promotion codes.

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 - This method should never be thrown because there is no data retrieved to populate the data bean.

See Also:

SmartDataBean.populate()

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

See Also:

Delegator.getDelegate()

getCodes

public PromotionCodeData[] getCodes()

Returns the promotion code constructs.

Returns:

An array of PromotionCode constructs.