atg.commerce.order.abandoned
Class TransientOrderEvent

java.lang.Object
  atg.commerce.messaging.CommerceMessageImpl
      atg.commerce.order.abandoned.TransientOrderEvent

All Implemented Interfaces:

CommerceMessage, java.io.Serializable

public class TransientOrderEvent
extends CommerceMessageImpl

This class is used to create transient order messages that indicate when an order has been either abandoned or submitted by a transient user

See Also:

AbandonedOrderEventListener, Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	TYPE

Constructor Summary

TransientOrderEvent()

TransientOrderEvent(RepositoryItem pProfile, java.lang.String pOrderId, double pAmount, java.lang.String pCurrencyCode, int pSubmitted)

Method Summary

double	getAmount()
java.lang.String	getCurrencyCode()
java.lang.String	getOrderId()
RepositoryItem	getProfile()
RepositoryItem	getSubject()
int	getSubmitted()
java.lang.String	getType() return the TYPE of the message
void	setAmount(double pAmount) The monetary value of the order.
void	setCurrencyCode(java.lang.String pCurrencyCode) The currency code for the monetary value of the order.
void	setOrderId(java.lang.String pOrderId) The ID of the order associated with the event.
void	setProfile(RepositoryItem pProfile) The profile associated with the event.
void	setSubmitted(int pSubmitted) A "0" value indicates the order was not submitted.
void	setType(java.lang.String pType) The JMS message TYPE of the message.
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

See Also:

Constant Field Values

Constructor Detail

TransientOrderEvent

public TransientOrderEvent()

TransientOrderEvent

public TransientOrderEvent(RepositoryItem pProfile,
                           java.lang.String pOrderId,
                           double pAmount,
                           java.lang.String pCurrencyCode,
                           int pSubmitted)

Method Detail

setOrderId

public void setOrderId(java.lang.String pOrderId)

The ID of the order associated with the event.

Parameters:

pOrderId - the ID of the order associated with the event.

getOrderId

public java.lang.String getOrderId()

Returns:

returns the ID of the order associated with the event.

setProfile

public void setProfile(RepositoryItem pProfile)

The profile associated with the event.

Parameters:

pProfile - the profile associated with the event.

getProfile

public RepositoryItem getProfile()

Returns:

returns the profile associated with the event.

setAmount

public void setAmount(double pAmount)

The monetary value of the order.

Parameters:

pAmount - the monetary value of the order.

getAmount

public double getAmount()

Returns:

returns the monetary value of the order.

setCurrencyCode

public void setCurrencyCode(java.lang.String pCurrencyCode)

The currency code for the monetary value of the order.

Parameters:

pCurrencyCode - the currency code

getCurrencyCode

public java.lang.String getCurrencyCode()

Returns:

returns the currency code for the monetary value of the order.

setSubmitted

public void setSubmitted(int pSubmitted)

A "0" value indicates the order was not submitted. A "100" value indicates the order has been submitted. This is so that the reporting mechanism can more easily display a conversion percentage.

Parameters:

pSubmitted - A "0" value indicates the order was not submitted. A "100" value indicates the order has been submitted.

getSubmitted

public int getSubmitted()

Returns:

returns A "0" value to indicate the order was not submitted. A "100" value to indicate the order has been submitted.

setType

public void setType(java.lang.String pType)

The JMS message TYPE of the message. The default type is atg.commerce.order.abandoned.TransientOrderEvent

Parameters:

pType - the JMS message TYPE of the message.

getType

public java.lang.String getType()

Description copied from class: CommerceMessageImpl

return the TYPE of the message

Specified by:

getType in interface CommerceMessage

Overrides:

getType in class CommerceMessageImpl

Returns:

returns the JMS message TYPE of the message

getSubject

public RepositoryItem getSubject()

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

Returns:

returns a readable string representing the contents of this message.