atg.commerce.order.abandoned
Class AbandonedOrderMessageFactory

java.lang.Object
  atg.commerce.order.abandoned.AbandonedOrderMessageFactory

public class AbandonedOrderMessageFactory
extends java.lang.Object

This class contains methods used by several components of the Abandoned Shopping Carts feature. It also provides a central location for the definition of property, repository item, order state, and abandonment state names. There are methods that are used to send the various abandonment JMS messages, and perform the functions needed for the SetLastUpdated, ReanimatedAbandonedOrder, and ConvertAbandonedOrder scenario actions and droplets.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

AbandonedOrderMessageFactory()

Method Summary

protected OrderAbandoned	createAbandonmentMessage(RepositoryItem pAbandonmentInfo) This method creates a generic order abandonment message.
protected OrderAbandoned	createAbandonmentMessage(RepositoryItem pAbandonmentInfo, java.lang.String pSiteId, java.lang.String pAbandonmentState) This method creates an OrderLost JMS message.
protected OrderAbandoned	createAbandonmentMessage(java.lang.String pOrderId, java.lang.String pProfileId, java.lang.String pAbandonmentState) This method creates a generic order abandonment message.
protected OrderAbandoned	createAbandonmentMessage(java.lang.String pOrderId, java.lang.String pProfileId, java.lang.String pAbandonmentState, java.lang.String pSiteId) This method creates a generic order abandonment message.
protected OrderAbandoned	createOrderAbandonedMessage(RepositoryItem pAbandonmentInfo) This method creates an OrderAbandoned JMS message.
protected OrderAbandoned	createOrderAbandonedMessage(RepositoryItem pAbandonmentInfo, java.lang.String pSiteId) This method creates an OrderAbandoned JMS message.
protected OrderAbandoned	createOrderConvertedMessage(RepositoryItem pAbandonmentInfo) This method creates an OrderConverted JMS message.
protected OrderAbandoned	createOrderConvertedMessage(RepositoryItem pAbandonmentInfo, java.lang.String pSiteId) This method creates an OrderConverted JMS message.
protected OrderAbandoned	createOrderLostMessage(RepositoryItem pAbandonmentInfo) This method creates an OrderLost JMS message.
protected OrderAbandoned	createOrderLostMessage(RepositoryItem pAbandonmentInfo, java.lang.String pSiteId) This method creates an OrderLost JMS message.
protected OrderAbandoned	createOrderLostMessage(java.lang.String pOrderId, java.lang.String pProfileId, java.lang.String pAbandonmentState) This method creates an OrderLost JMS message.
protected OrderAbandoned	createOrderLostMessage(java.lang.String pOrderId, java.lang.String pProfileId, java.lang.String pAbandonmentState, java.lang.String pSiteId) This method creates an OrderLost JMS message.
protected OrderAbandoned	createOrderReanimatedMessage(RepositoryItem pAbandonmentInfo) This method creates an OrderReanimated JMS message.
protected OrderAbandoned	createOrderReanimatedMessage(RepositoryItem pAbandonmentInfo, java.lang.String pSiteId) This method creates an OrderReanimated JMS message.
AbandonedOrderTools	getAbandonedOrderTools()
java.lang.String	getOrderAbandonedMessageType()
java.lang.String	getOrderConvertedMessageType()
java.lang.String	getOrderLostMessageType()
java.lang.String	getOrderReanimatedMessageType()
void	setAbandonedOrderTools(AbandonedOrderTools pAbandonedOrderTools) AbandonedOrderTools contains property/item names and helper methods.
void	setOrderAbandonedMessageType(java.lang.String pOrderAbandonedMessageType) The JMS type of the OrderAbandoned message.
void	setOrderConvertedMessageType(java.lang.String pOrderConvertedMessageType) The JMS type of the OrderConverted message.
void	setOrderLostMessageType(java.lang.String pOrderLostMessageType) The JMS type of the OrderLost message.
void	setOrderReanimatedMessageType(java.lang.String pOrderReanimatedMessageType) The JMS type of the OrderReanimated message.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

AbandonedOrderMessageFactory

public AbandonedOrderMessageFactory()

Method Detail

setAbandonedOrderTools

public void setAbandonedOrderTools(AbandonedOrderTools pAbandonedOrderTools)

AbandonedOrderTools contains property/item names and helper methods.

Parameters:

pAbandonedOrderTools - the AbandonedOrderTools helper component.

getAbandonedOrderTools

public AbandonedOrderTools getAbandonedOrderTools()

Returns:

returns the AbandonedOrderTools helper component.

setOrderAbandonedMessageType

public void setOrderAbandonedMessageType(java.lang.String pOrderAbandonedMessageType)

The JMS type of the OrderAbandoned message.

Parameters:

pOrderAbandonedMessageType - the JMS type of the OrderAbandoned message.

getOrderAbandonedMessageType

public java.lang.String getOrderAbandonedMessageType()

Returns:

Returns the JMS type of the OrderAbandoned message.

setOrderReanimatedMessageType

public void setOrderReanimatedMessageType(java.lang.String pOrderReanimatedMessageType)

The JMS type of the OrderReanimated message.

Parameters:

pOrderReanimatedMessageType - the JMS type of the OrderReanimated message.

getOrderReanimatedMessageType

public java.lang.String getOrderReanimatedMessageType()

Returns:

Returns the JMS type of the OrderReanimated message.

setOrderConvertedMessageType

public void setOrderConvertedMessageType(java.lang.String pOrderConvertedMessageType)

The JMS type of the OrderConverted message.

Parameters:

pOrderConvertedMessageType - the JMS type of the OrderConverted message.

getOrderConvertedMessageType

public java.lang.String getOrderConvertedMessageType()

Returns:

Returns the JMS type of the OrderConverted message.

setOrderLostMessageType

public void setOrderLostMessageType(java.lang.String pOrderLostMessageType)

The JMS type of the OrderLost message.

Parameters:

pOrderLostMessageType - the JMS type of the OrderLost message.

getOrderLostMessageType

public java.lang.String getOrderLostMessageType()

Returns:

Returns the JMS type of the OrderLost message.

createAbandonmentMessage

protected OrderAbandoned createAbandonmentMessage(RepositoryItem pAbandonmentInfo)
                                           throws RepositoryException

This method creates a generic order abandonment message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the abandoned order

Throws:

RepositoryException

createAbandonmentMessage

protected OrderAbandoned createAbandonmentMessage(java.lang.String pOrderId,
                                                  java.lang.String pProfileId,
                                                  java.lang.String pAbandonmentState)

This method creates a generic order abandonment message. This instance can be used for lost orders, when it is possible the order has been deleted and no longer exists, so we have no means through the repository of obtaining the properties associated with the order.

Parameters:

pOrderId - the id of the abandoned order.

pProfileId - the id of the profile that is associated with the order.

pAbandonmentState - the abandonment state of the order.

createAbandonmentMessage

protected OrderAbandoned createAbandonmentMessage(java.lang.String pOrderId,
                                                  java.lang.String pProfileId,
                                                  java.lang.String pAbandonmentState,
                                                  java.lang.String pSiteId)

This method creates a generic order abandonment message. This instance can be used for lost orders, when it is possible the order has been deleted and no longer exists, so we have no means through the repository of obtaining the properties associated with the order.

Parameters:

pOrderId - the id of the abandoned order.

pProfileId - the id of the profile that is associated with the order.

pAbandonmentState - the abandonment state of the order.

createOrderAbandonedMessage

protected OrderAbandoned createOrderAbandonedMessage(RepositoryItem pAbandonmentInfo)
                                              throws RepositoryException

This method creates an OrderAbandoned JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the abandoned order

Throws:

RepositoryException

createOrderAbandonedMessage

protected OrderAbandoned createOrderAbandonedMessage(RepositoryItem pAbandonmentInfo,
                                                     java.lang.String pSiteId)
                                              throws RepositoryException

This method creates an OrderAbandoned JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the abandoned order

pSiteId - site id associated with the message.

Throws:

RepositoryException

createOrderReanimatedMessage

protected OrderAbandoned createOrderReanimatedMessage(RepositoryItem pAbandonmentInfo)
                                               throws RepositoryException

This method creates an OrderReanimated JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the reanimated order

Throws:

RepositoryException

createOrderReanimatedMessage

protected OrderAbandoned createOrderReanimatedMessage(RepositoryItem pAbandonmentInfo,
                                                      java.lang.String pSiteId)
                                               throws RepositoryException

This method creates an OrderReanimated JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the reanimated order

pSiteId - site id associated with the message.

Throws:

RepositoryException

createOrderConvertedMessage

protected OrderAbandoned createOrderConvertedMessage(RepositoryItem pAbandonmentInfo)
                                              throws RepositoryException

This method creates an OrderConverted JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the converted order

Throws:

RepositoryException

createOrderConvertedMessage

protected OrderAbandoned createOrderConvertedMessage(RepositoryItem pAbandonmentInfo,
                                                     java.lang.String pSiteId)
                                              throws RepositoryException

This method creates an OrderConverted JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the converted order

pSiteId - site id associated with the message.

Throws:

RepositoryException

createOrderLostMessage

protected OrderAbandoned createOrderLostMessage(RepositoryItem pAbandonmentInfo)
                                         throws RepositoryException

This method creates an OrderLost JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the lost order

Throws:

RepositoryException

createOrderLostMessage

protected OrderAbandoned createOrderLostMessage(RepositoryItem pAbandonmentInfo,
                                                java.lang.String pSiteId)
                                         throws RepositoryException

This method creates an OrderLost JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the lost order

Throws:

RepositoryException

createAbandonmentMessage

protected OrderAbandoned createAbandonmentMessage(RepositoryItem pAbandonmentInfo,
                                                  java.lang.String pSiteId,
                                                  java.lang.String pAbandonmentState)
                                           throws RepositoryException

This method creates an OrderLost JMS message.

Parameters:

pAbandonmentInfo - the abandonmentInfo repository item associated with the lost order

Throws:

RepositoryException

createOrderLostMessage

protected OrderAbandoned createOrderLostMessage(java.lang.String pOrderId,
                                                java.lang.String pProfileId,
                                                java.lang.String pAbandonmentState)

This method creates an OrderLost JMS message. This method requires a profile ID because lost orders could possibly have been removed from the repository, so we have no means of obtaining the order's profile ID through the repository.

createOrderLostMessage

protected OrderAbandoned createOrderLostMessage(java.lang.String pOrderId,
                                                java.lang.String pProfileId,
                                                java.lang.String pAbandonmentState,
                                                java.lang.String pSiteId)

This method creates an OrderLost JMS message. This method requires a profile ID because lost orders could possibly have been removed from the repository, so we have no means of obtaining the order's profile ID through the repository.