com.ibm.commerce.giftregistry.beans

Class GiftRegistryAnnouncementHistoryDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.component.giftregistry.objects.GiftRegistryAnnouncementHistoryAccessBean

com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementHistoryDataBeanBase

com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementHistoryDataBean

All Implemented Interfaces:

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

public class GiftRegistryAnnouncementHistoryDataBean
extends com.ibm.commerce.giftregistry.beans.GiftRegistryAnnouncementHistoryDataBeanBase
implements SmartDataBean, InputDataBean

Used to retrieve announcement history for a gift registry from grannhist and gremllist database tables given an announcementId. Announcement history consists of announcement's receivers, sender, date and announcement message.

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
GiftRegistryAnnouncementHistoryDataBean() Default constructor
GiftRegistryAnnouncementHistoryDataBean(GiftRegistryAnnouncementHistoryAccessBean object) Creates this data bean based on its parent access bean

Method Summary

Modifier and Type	Method and Description
GiftRegistryAnnouncementEmailDataBean[]	getAnnouncementEmailDataBeans() Gets a list of announcement e-mail data beans that represent recipient e-mail information for a particular announcement
java.lang.Long	getAnnouncementId() Gets the announcement ID.
java.lang.String	getField1() Gets the customizable field 1 of the announcement history.
java.lang.String	getField2() Gets the customizable field 2 of the announcement history.
java.lang.Long	getGiftRegistryId() Returns the gift registry ID to which this announcement history belongs
java.lang.String	getMessage() Gets the customizable field 3 of the announcement history.
TypedProperty	getRequestProperties() Returns the request properties of the data bean.
java.lang.String	getSenderEmail() Gets the e-mail address of the sender of the announcement
java.lang.String	getSenderName() Gets the name of the sender of this announcement history
java.sql.Date	getSentDate() Gets the sent date of this announcement
void	populate() Loads data into the data bean when the DataBeanManager.activate() runs.
void	setAnnouncementId(java.lang.Long newAnnouncementId) Sets the announcement ID to populate this bean.
void	setRequestProperties(TypedProperty param) Sets the request properties within this bean.

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

getCommandContext, getDelegate, setCommandContext

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

findAnnouncementByGiftRegistryIdOrderBySentDate, fulfills, getAnnounceHistoryId, getEntity, getOwner, getUserRelationship, instantiateEntity, setAnnounceHistoryId, setField1, setField2, setGiftRegistryId, setInitKey_announceHistoryId, setMessage, setSenderEmail, setSenderName, setSentDate, setUserRelationship

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

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

GiftRegistryAnnouncementHistoryDataBean

public GiftRegistryAnnouncementHistoryDataBean()

Default constructor

GiftRegistryAnnouncementHistoryDataBean

public GiftRegistryAnnouncementHistoryDataBean(GiftRegistryAnnouncementHistoryAccessBean object)
                                        throws ECSystemException

Creates this data bean based on its parent access bean

Parameters:

GiftRegistryAnnouncementAccessBean -

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. You must set the announcementId using the setAnnouncementId method before running the populate() method

Specified by:

populate in interface SmartDataBean

Throws:

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

getGiftRegistryId

public java.lang.Long getGiftRegistryId()

Returns the gift registry ID to which this announcement history belongs

Overrides:

getGiftRegistryId in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

The gift registry ID to which announcement history belongs to

getAnnouncementId

public java.lang.Long getAnnouncementId()

Gets the announcement ID.

Returns:

The announcement ID.

setAnnouncementId

public void setAnnouncementId(java.lang.Long newAnnouncementId)

Sets the announcement ID to populate this bean. This is a required parameter to populate this bean.

Parameters:

newAnnouncementId - - The Announcement ID

getField1

public java.lang.String getField1()

Gets the customizable field 1 of the announcement history.

Overrides:

getField1 in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

The announcement history field1 value

getField2

public java.lang.String getField2()

Gets the customizable field 2 of the announcement history.

Overrides:

getField2 in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

The customizable field 2 of the announcement history.

getMessage

public java.lang.String getMessage()

Gets the customizable field 3 of the announcement history.

Overrides:

getMessage in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

The customizable field 3 of the announcement history.

getSenderEmail

public java.lang.String getSenderEmail()

Gets the e-mail address of the sender of the announcement

Overrides:

getSenderEmail in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

The e-mail address of the sender of the announcement

getSenderName

public java.lang.String getSenderName()

Gets the name of the sender of this announcement history

Overrides:

getSenderName in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

Returns the name of the sender of this announcement history

getSentDate

public java.sql.Date getSentDate()

Gets the sent date of this announcement

Overrides:

getSentDate in class GiftRegistryAnnouncementHistoryAccessBean

Returns:

Returns the sent date of this announcement

getAnnouncementEmailDataBeans

public GiftRegistryAnnouncementEmailDataBean[] getAnnouncementEmailDataBeans()

Gets a list of announcement e-mail data beans that represent recipient e-mail information for a particular announcement

Returns:

An array of GiftRegistryAnnouncementEmailDataBean.