atg.commerce.order.processor

Class ProcSendScenarioEvent

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.EventSender

atg.commerce.order.processor.ProcSendScenarioEvent

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 ProcSendScenarioEvent
extends EventSender

This processor sends scenario action events to the scenario server. The events are those such as ItemAddedToOrder and ItemRemovedFromOrder.

See Also:

EventSender, ItemAddedToOrder, ItemRemovedFromOrder

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
ProcSendScenarioEvent()

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	createEventToSend(java.lang.Object pParam, PipelineResult pResult) This method creates and populates various Commerce event objects that represent messages which will be sent to the scenario engine.
java.lang.String	getEventType(java.lang.Object pEventToSend) If this object is a ScenarioEvent or CommerceMessage, then that message's type is returned.
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.
protected java.io.Serializable	handleOtherEventToSend(java.lang.Object pParam, PipelineResult pResult) This method is used to deal with other event type.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setMessageSourceName(java.lang.String pMessageSourceName)

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

getEventType, getMessageIdGenerator, getMessageIdSpaceName, getMessageSourceContext, getNextMessageId, getPortName, getRetCodes, getSiteId, isAllowMessageSending, runProcess, 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

ProcSendScenarioEvent

public ProcSendScenarioEvent()

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

createEventToSend

public java.io.Serializable createEventToSend(java.lang.Object pParam,
                                              PipelineResult pResult)
                                       throws java.lang.Exception

This method creates and populates various Commerce event objects that represent messages which will be sent to the scenario engine. The objects created here are:

• ItemAddedToOrder
• ItemRemovedFromOrder
• ItemQuantityChanged
• ScenarioAddedItemToOrder
• OrderSaved
• OrdersMerged

If the event is an ItemQuantityChanged event, then the quantity that is in pParams is the old quantity of the item, prior to the change.

Unknown event types are passed along to handleOtherEventToSend.

Overrides:

createEventToSend in class EventSender

Parameters:

pParam - the Map which contains all the message parameters

pResult - the PipelineResult object which is supplied to runProcess()

Returns:

the Serializable message object

Throws:

java.lang.Exception

getEventType

public java.lang.String getEventType(java.lang.Object pEventToSend)

If this object is a ScenarioEvent or CommerceMessage, then that message's type is returned. Otherwise super.getEventType() is returned.

Overrides:

getEventType in class EventSender

Parameters:

pEventToSend - The event that will be sent whose type will be sent

Returns:

The type of the event

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.

handleOtherEventToSend

protected java.io.Serializable handleOtherEventToSend(java.lang.Object pParam,
                                                      PipelineResult pResult)
                                               throws java.lang.Exception

This method is used to deal with other event type. User should override this method if they want to deal with other event type.

Parameters:

pParam - the Map which contains all the message parameters

pResult - the PipelineResult object which is supplied to runProcess()

Returns:

the Serializable message object

Throws:

java.lang.Exception