|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.logging.ApplicationLoggingImpl atg.commerce.order.processor.EventSender atg.commerce.order.processor.ProcSendPromotionUsedMessage
public class ProcSendPromotionUsedMessage
This processor sends an event to the scenario engine when an promotion is used in an order. A promotion is "used" when an order is processed. The event object sent is PromotionUsed.
PromotionUsed
,
EventSender
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 | |
---|---|
ProcSendPromotionUsedMessage()
|
Method Summary | |
---|---|
java.io.Serializable |
createEventToSend(Order pOrder,
PricingAdjustment pAdjustment,
RepositoryItem pProfile)
This method creates and populates a PromotionUsed object. |
java.io.Serializable |
createEventToSend(Order pOrder,
PricingAdjustment pAdjustment,
RepositoryItem pProfile,
java.lang.Object pParam)
This method creates and populates a PromotionUsed object. |
java.io.Serializable |
createEventToSend(Order order,
RepositoryItem promo,
RepositoryItem profile)
This method creates and populates a PromotionUsed 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. |
PromotionTools |
getPromotionTools()
Returns the promotionTools |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method will loop through all the promotions calling @see #createEventToSend which will return the event object to be sent. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
void |
setMessageSourceName(java.lang.String pMessageSourceName)
|
void |
setPromotionTools(PromotionTools pPromotionTools)
Sets the promotionTools |
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.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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ProcSendPromotionUsedMessage()
Method Detail |
---|
public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
runProcess
in class EventSender
pParam
- a HashMap which must contain an Order and Profile objectpResult
- a PipelineResult object which stores any information which must
be returned from this method invokation
java.lang.Exception
- throws any exception back to the callerThis 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)
public java.io.Serializable createEventToSend(Order order, RepositoryItem promo, RepositoryItem profile)
order
- the order to set in the messagepromo
- the promotion to set in the messageprofile
- the profile to set in the message
public java.io.Serializable createEventToSend(Order pOrder, PricingAdjustment pAdjustment, RepositoryItem pProfile)
pOrder
- the order to set in the messagepAdjustment
- the pricing adjustment to set promotion and discount in the messagepProfile
- the profile to set in the message
public java.io.Serializable createEventToSend(Order pOrder, PricingAdjustment pAdjustment, RepositoryItem pProfile, java.lang.Object pParam)
pOrder
- the order to set in the messagepAdjustment
- the pricing adjustment to set promotion and discount in the messagepProfile
- the profile to set in the messagepParam
- pipeline parameters map to extract site id property
public PromotionTools getPromotionTools()
public void setPromotionTools(PromotionTools pPromotionTools)
public void setMessageSourceName(java.lang.String pMessageSourceName)
public java.lang.String getMessageSourceName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |