|
|||||||||
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.ProcMoveUsedPromotions
public class ProcMoveUsedPromotions
This processor moves any used promotions in the user's profile from the activePromotions list to the usedPromotions list. If the promotion is marked as "use once" then it is moved. If it is allowed to be used as many times as the user wishes then it is not moved.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
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 | |
---|---|
ProcMoveUsedPromotions()
|
Method Summary | |
---|---|
java.lang.String |
getLoggingIdentifier()
Returns property LoggingIdentifier |
protected void |
getPromotionsToConsume(java.util.Map pParameters,
Order pOrder,
java.util.Collection pOrderPromotions,
java.util.Collection pTaxPromotions,
java.util.Collection pItemPromotions,
java.util.Collection pShippingPromotions)
This API is called to populate the given collections with the promotions that should be consumed. |
PromotionTools |
getPromotionTools()
Returns the promotionTools |
int[] |
getRetCodes()
Returns the valid return codes 1 - The processor completed |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method moves the used promotions in an order to the usedPromotions list in their profile. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
void |
setPromotionTools(PromotionTools pPromotionTools)
Sets the promotionTools |
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ProcMoveUsedPromotions()
Method Detail |
---|
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
public PromotionTools getPromotionTools()
public void setPromotionTools(PromotionTools pPromotionTools)
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
pParam
- a HashMap which must contain an Order and optionally a Locale 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 callerPipelineProcessor.runProcess(Object, PipelineResult)
protected void getPromotionsToConsume(java.util.Map pParameters, Order pOrder, java.util.Collection pOrderPromotions, java.util.Collection pTaxPromotions, java.util.Collection pItemPromotions, java.util.Collection pShippingPromotions)
Implementations should add the promotions to the collections provided.
pParameters
- the pipeline's incoming parameter mappOrder
- the orderpOrderPromotions
- the collection to which order level promotions should be addedpTaxPromotions
- the collection to which tax level promotions should be addedpItemPromotions
- the collection to which item level promotions should be addedpShippingPromotions
- the collection to which shipping level promotions should be added
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |