atg.commerce.order.processor
Class ProcSendFulfillmentMessage

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.logging.ApplicationLoggingImpl
          extended by atg.commerce.order.processor.EventSender
              extended by atg.commerce.order.processor.ProcSendFulfillmentMessage
All Implemented Interfaces:
MessageSource, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcSendFulfillmentMessage
extends EventSender

This processor sends a message to the fulfillment engine when an order has been processed. This message tells the Fulfillment engine to begin fulfilling the Order in the message.

See Also:
EventSender, SubmitOrder

Field Summary
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
ProcSendFulfillmentMessage()
           
 
Method Summary
 java.io.Serializable createEventToSend(java.lang.Object pParam, PipelineResult pResult)
          This method creates and populates a SubmitOrder object.
 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()
          Returns property ProfileTools
 void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
          Sets property LoggingIdentifier
 void setMessageSourceName(java.lang.String pMessageSourceName)
           
 void setProfileTools(CommerceProfileTools pProfileTools)
          Sets property ProfileTools
 
Methods inherited from class atg.commerce.order.processor.EventSender
getEventType, getEventType, getMessageIdGenerator, getMessageIdSpaceName, getMessageSourceContext, getNextMessageId, getPortName, getRetCodes, 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, 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

ProcSendFulfillmentMessage

public ProcSendFulfillmentMessage()
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

setProfileTools

public void setProfileTools(CommerceProfileTools pProfileTools)
Sets property ProfileTools


getProfileTools

public CommerceProfileTools getProfileTools()
Returns property ProfileTools


createEventToSend

public java.io.Serializable createEventToSend(java.lang.Object pParam,
                                              PipelineResult pResult)
                                       throws java.lang.Exception
This method creates and populates a SubmitOrder object. The SubmitOrder object is the message which will be sent to the Fulfillment engine.

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

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.