atg.commerce.order.processor

Class ProcSendGiftPurchasedMessage

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.EventSender

atg.commerce.order.processor.ProcSendGiftPurchasedMessage

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, MessageSource, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcSendGiftPurchasedMessage
extends EventSender

This processor sends an event to the scenario engine when a gift has been purchased. A gift is "purchased" when an order is processed. The event object sent is GiftPurchased.

See Also:

GiftPurchased, EventSender

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.order.processor.EventSender

FAILURE, SUCCESS

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ProcSendGiftPurchasedMessage()

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	createEventToSend(Order pOrder, CommerceItem pItem, RepositoryItem pProfile) This method creates and populates a GiftPurchased object.
java.io.Serializable	createEventToSend(Order pOrder, CommerceItem pItem, RepositoryItem pProfile, java.lang.Object pParam) This method creates and populates a GiftPurchased object.
GiftlistManager	getGiftlistManager() All Giftlist manipulations are done with this.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getMessageSourceName() This defines the string that the source property of messages will be set to.
CommerceProfileTools	getProfileTools() property profileTools
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method will loop through all the items in the order calling @see #createEventToSend which will return the event object to be sent.
void	setGiftlistManager(GiftlistManager pGiftlistManager)
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setMessageSourceName(java.lang.String pMessageSourceName)
void	setProfileTools(CommerceProfileTools pProfileTools)

Methods inherited from class atg.commerce.order.processor.EventSender

createEventToSend, getEventType, getEventType, getMessageIdGenerator, getMessageIdSpaceName, getMessageSourceContext, getNextMessageId, getPortName, getRetCodes, getSiteId, isAllowMessageSending, sendObjectMessage, setAllowMessageSending, setEventType, setMessageIdGenerator, setMessageIdSpaceName, setMessageSourceContext, setPortName, startMessageSource, stopMessageSource

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

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

ProcSendGiftPurchasedMessage

public ProcSendGiftPurchasedMessage()

Method Detail

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Sets property LoggingIdentifier

Overrides:

setLoggingIdentifier in class ApplicationLoggingImpl

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Returns property LoggingIdentifier

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

This method will loop through all the items in the order calling @see #createEventToSend which will return the event object to be sent. @see #sendObjectMessage will be called with the event to be sent, along with the @see #getEventType and the

Specified by:

runProcess in interface PipelineProcessor

Overrides:

runProcess in class EventSender

Parameters:

pParam - a HashMap which must contain an Order and Profile object

pResult - a PipelineResult object which stores any information which must be returned from this method invokation

Returns:

an integer specifying the processor's return code

Throws:

java.lang.Exception - throws any exception back to the caller

See Also:

This method requires that an Order and Profile object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap., PipelineProcessor.runProcess(Object, PipelineResult)

createEventToSend

public java.io.Serializable createEventToSend(Order pOrder,
                                              CommerceItem pItem,
                                              RepositoryItem pProfile)

This method creates and populates a GiftPurchased object. The GiftPurchased object is the message which will be sent to the scenario engine.

Parameters:

order - the order to set in the message

pItem - the commerce item to set in the message

profile - the profile to set in the message

Returns:

the Serializable message object

createEventToSend

public java.io.Serializable createEventToSend(Order pOrder,
                                              CommerceItem pItem,
                                              RepositoryItem pProfile,
                                              java.lang.Object pParam)

This method creates and populates a GiftPurchased object. The GiftPurchased object is the message which will be sent to the scenario engine.

Parameters:

pOrder - the order to set in the message

pItem - the commerce item to set in the message

pProfile - the profile to set in the message

pParam - pipeline parameters map to extract site id property

Returns:

the Serializable message object

setGiftlistManager

public void setGiftlistManager(GiftlistManager pGiftlistManager)

getGiftlistManager

public GiftlistManager getGiftlistManager()

All Giftlist manipulations are done with this.

setProfileTools

public void setProfileTools(CommerceProfileTools pProfileTools)

getProfileTools

public CommerceProfileTools getProfileTools()

property profileTools

setMessageSourceName

public void setMessageSourceName(java.lang.String pMessageSourceName)

getMessageSourceName

public java.lang.String getMessageSourceName()

This defines the string that the source property of messages will be set to.