atg.commerce.gifts
Class GiftPurchased

java.lang.Object
  atg.commerce.messaging.CommerceMessageImpl
      atg.commerce.gifts.GiftPurchased

All Implemented Interfaces:

CommerceMessage, java.io.Serializable

public class GiftPurchased
extends CommerceMessageImpl

This message will be sent to the Dynamo Scenario Server when a gift is purchased off someone's giftlist. This can be used to trigger an event such as sending an email notification to the customer. The message will contain the order, the profile of the customer the gift is for and the commerce item itself.

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	TYPE This is the JMS message type for the message that this class represents.

Constructor Summary

GiftPurchased()

Method Summary

CommerceItem	getItem() return the gift.
Order	getOrder() return the order in which the gift was purchased.
RepositoryItem	getProfile() return the profile of the recipient
java.lang.String	getProfileId() Returns profileId from the Profile property.
java.lang.String	getType() return the JMS message TYPE of the message
void	setItem(CommerceItem pItem) This property is the CommerceItem of the Gift
void	setOrder(Order pOrder) Sets the property of the order.
void	setProfile(RepositoryItem pProfile) Sets the profile of the recipient
java.lang.String	toString() This method returns a readable string representing the contents of this message.

Methods inherited from class atg.commerce.messaging.CommerceMessageImpl

appendBaseToString, getId, getOriginalId, getOriginalSource, getOriginalUserId, getParentSessionId, getSessionId, getSiteId, getSource, getUserId, setId, setOriginalId, setOriginalSource, setOriginalUserId, setParentSessionId, setSessionId, setSiteId, setSource, setUserId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

TYPE

public static final java.lang.String TYPE

This is the JMS message type for the message that this class represents.

See Also:

Constant Field Values

Constructor Detail

GiftPurchased

public GiftPurchased()

Method Detail

getType

public java.lang.String getType()

return the JMS message TYPE of the message

Specified by:

getType in interface CommerceMessage

Overrides:

getType in class CommerceMessageImpl

Returns:

the JMS message TYPE of the message

getOrder

public Order getOrder()

return the order in which the gift was purchased.

Returns:

the order in which the gift was purchased.

setOrder

public void setOrder(Order pOrder)

Sets the property of the order.

Parameters:

pOrder - the order in which the gift was purchased.

See Also:

Order

getProfile

public RepositoryItem getProfile()

return the profile of the recipient

Returns:

the profile of the recipient

setProfile

public void setProfile(RepositoryItem pProfile)

Sets the profile of the recipient

Parameters:

pProfile - the profile of the recipient of the gift.

See Also:

Profile

getProfileId

public java.lang.String getProfileId()

Returns profileId from the Profile property. if Profile property is null then null is returned.

Returns:

the profileId of the recipient

getItem

public CommerceItem getItem()

return the gift.

Returns:

the gift.

setItem

public void setItem(CommerceItem pItem)

This property is the CommerceItem of the Gift

Parameters:

pItem - the commerceItem which represents the gift

See Also:

CommerceItem

toString

public java.lang.String toString()

This method returns a readable string representing the contents of this message.

Overrides:

toString in class java.lang.Object