com.ibm.commerce.giftregistry.beans

Class GiftRegistryAnnouncementEmailDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.component.giftregistry.objects.GiftRegistryAnnouncementEmailListAccessBean

com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementEmailDataBeanBase

com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementEmailDataBean

All Implemented Interfaces:

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

public class GiftRegistryAnnouncementEmailDataBean
extends com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementEmailDataBeanBase
implements SmartDataBean, InputDataBean

Extends GiftRegistryAnnouncementEmailDataBeanBase and provides a JSP friendly way of accessing announcement templates from the database. Used to retrieve a gift registry announcement e-mail data from grannhist, granntmplt and gremllist database tables.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

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

emptyString

Constructor Summary

Constructors

Constructor and Description
GiftRegistryAnnouncementEmailDataBean() Generates an empty GiftRegistryAnnouncementEmailDataBean
GiftRegistryAnnouncementEmailDataBean(GiftRegistryAnnouncementEmailListAccessBean object) Creates this data bean based on its parent access bean

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAnnouncementHistoryId() Returns the announcement history ID to which this e-mail list belongs
java.lang.String	getEmail() Returns the e-mail for this announcement
java.lang.String	getName() Returns the name of the receiver of this announcement
TypedProperty	getRequestProperties() Returns the request properties of the data bean.
java.lang.Integer	getType() Returns the type of e-mail address sent for this announcement.
void	populate() Loads data into the data bean when the DataBeanManager.activate() runs.
void	setRequestProperties(TypedProperty param) Sets the request properties within this bean.

Methods inherited from class com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementEmailDataBeanBase

getCommandContext, getDelegate, setCommandContext

Methods inherited from class com.ibm.commerce.component.giftregistry.objects.GiftRegistryAnnouncementEmailListAccessBean

findByAnnouncementHistoryId, getEmailListId, getEntity, instantiateEntity, setAnnouncementHistoryId, setEmail, setInitKey_emailListId, setName, setType

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object

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

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

getCommandContext, setCommandContext

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

GiftRegistryAnnouncementEmailDataBean

public GiftRegistryAnnouncementEmailDataBean()

Generates an empty GiftRegistryAnnouncementEmailDataBean

GiftRegistryAnnouncementEmailDataBean

public GiftRegistryAnnouncementEmailDataBean(GiftRegistryAnnouncementEmailListAccessBean object)
                                      throws ECSystemException

Creates this data bean based on its parent access bean

Parameters:

GiftRegistryAnnouncementEmailListAccessBean -

Throws:

ECSystemException

Method Detail

getRequestProperties

public TypedProperty getRequestProperties()

Returns the request properties of the data bean.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

The request properties.

setRequestProperties

public void setRequestProperties(TypedProperty param)

Sets the request properties within this bean.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

requestProperties - the set of properties passed to the JSP page that invokes this data bean,

Throws:

java.lang.Exception - if there is a problem when setting the request properties. This particular method should not throw any exception because it just stores the request properties.

populate

public void populate()

Loads data into the data bean when the DataBeanManager.activate() runs.

Specified by:

populate in interface SmartDataBean

Throws:

java.lang.Exception - if there is a problem populating the data bean.

getAnnouncementHistoryId

public java.lang.Long getAnnouncementHistoryId()

Returns the announcement history ID to which this e-mail list belongs

Overrides:

getAnnouncementHistoryId in class GiftRegistryAnnouncementEmailListAccessBean

Returns:

announcementHistoryId

getName

public java.lang.String getName()

Returns the name of the receiver of this announcement

Overrides:

getName in class GiftRegistryAnnouncementEmailListAccessBean

Returns:

name

getEmail

public java.lang.String getEmail()

Returns the e-mail for this announcement

Overrides:

getEmail in class GiftRegistryAnnouncementEmailListAccessBean

Returns:

email

getType

public java.lang.Integer getType()

Returns the type of e-mail address sent for this announcement. the type of the e-mail address. The types are supported out of box:

• 0: Normal address
• 1: the recipient is carbon copied
• 2: the recipient is blind carbon copied

Overrides:

getType in class GiftRegistryAnnouncementEmailListAccessBean

Returns:

type