atg.commerce.order.abandoned
Class OrderAbandoned

java.lang.Object
  extended by atg.commerce.messaging.CommerceMessageImpl
      extended by atg.commerce.order.abandoned.OrderAbandoned
All Implemented Interfaces:
CommerceMessage, java.io.Serializable

public class OrderAbandoned
extends CommerceMessageImpl

This class is used to create each of the types of order abandonment messages: OrderAbandoned, OrderReanimated, OrderConverted, and OrderLost. This class is used by AbandonedOrderTools to build the object messages.

See Also:
AbandonedOrderTools, Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
OrderAbandoned()
           
 
Method Summary
 java.lang.String getAbandonmentState()
           
 double getAmount()
           
 java.lang.String getCurrencyCode()
           
 java.lang.String getOrderId()
           
 java.lang.String getProfileId()
           
 java.lang.String getType()
          return the TYPE of the message
 void setAbandonmentState(java.lang.String pAbandonmentState)
          The abandonment state of the order.
 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 setProfileId(java.lang.String pProfileId)
          The profile ID of the owner of the order.
 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, getSource, getUserId, setId, setOriginalId, setOriginalSource, setOriginalUserId, setParentSessionId, setSessionId, 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

Constructor Detail

OrderAbandoned

public OrderAbandoned()
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.

setProfileId

public void setProfileId(java.lang.String pProfileId)
The profile ID of the owner of the order.

Parameters:
pProfileId - the profile ID of the owner of the order.

getProfileId

public java.lang.String getProfileId()
Returns:
returns the profile ID of the owner of the order.

setAbandonmentState

public void setAbandonmentState(java.lang.String pAbandonmentState)
The abandonment state of the order. The default abandonment states are ABANDONED, REANIMATED, CONVERTED, and LOST.

Parameters:
pAbandonmentState - the abandonment state of the order. The default abandonment states are ABANDONED, REANIMATED, CONVERTED, and LOST.

getAbandonmentState

public java.lang.String getAbandonmentState()
Returns:
returns the abandonment state of the order.

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.

setType

public void setType(java.lang.String pType)
The JMS message TYPE of the message. The default possible types are atg.commerce.order.abandoned.OrderAbandoned, atg.commerce.order.abandoned.OrderReanimated, atg.commerce.order.abandoned.OrderConverted, and atg.commerce.order.abandoned.OrderLost

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

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.