|
|||||||||
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.ProcRemoveExpiredCommerceItems
public class ProcRemoveExpiredCommerceItems
This processor is responsible for the removal of CommerceItems whose sku or product have been removed from the database from Orders whose states are specified in the @see OpenOrderStates. This processor works in conjunction with @see ProcSetCatalogRefs and @see ProcSetProductRefs which are responsible for the identification and substitution of the removed product and sku repository items from the commerce item object. If a sku is removed from the database and the order is in one of the states in the above list then the item is automatically removed. If a product is removed from the database then it is removed from the order only if the @see RemoveItemsWithDeletedProducts is set to true and the order state is in the @see OpenOrderStates list.
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 | |
---|---|
ProcRemoveExpiredCommerceItems()
|
Method Summary | |
---|---|
java.lang.String |
getLoggingIdentifier()
Returns property LoggingIdentifier |
java.lang.String[] |
getOpenOrderStates()
A list of order states that determine whether an item can be removed from the order. |
java.lang.String |
getRemovedProductId()
Value of the Repository id of the product item representing a removed product item. |
java.lang.String |
getRemovedSkuId()
Value of the repository id of the sku item representing a removed sku item from the database. |
int[] |
getRetCodes()
Returns the valid return codes 1 - The processor completed |
boolean |
isRemoveItemsWithDeletedProducts()
If true then the commerceitem is removed from the order if the product has been removed from the database. |
boolean |
isTreatNullOrderStateAsModifiable()
Specify whether orders whose order state is null should be considered modifiable or non-modifiable. |
boolean |
isWarnOnNullOrderState()
Query whether to issue a warning if asked to oeprate on an order whose order state is null. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method runs the actual processor and does the work. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
void |
setOpenOrderStates(java.lang.String[] pOpenOrderStates)
|
void |
setRemovedProductId(java.lang.String pRemovedProductId)
|
void |
setRemovedSkuId(java.lang.String pRemovedSkuId)
|
void |
setRemoveItemsWithDeletedProducts(boolean pRemoveItemsWithDeletedProducts)
|
void |
setTreatNullOrderStateAsModifiable(boolean pTreatNullOrderStateAsModifiable)
Specify whether orders whose order state is null should be considered modifiable or non-modifiable. |
void |
setWarnOnNullOrderState(boolean pWarnOnNullOrderState)
Specify whether to issue a warning if asked to operate on an order whose order state is null. |
boolean |
shouldItemBeRemoved(CommerceItem pCommerceItem)
Determines whether the CommerceItem that is being passed in should be removed based on whether the product or sku have been removed from the database. |
boolean |
shouldOrderBeModified(Order pOrder)
This method is used to determine whether the order that is passed in is in a state that allows it to be modified. |
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 ProcRemoveExpiredCommerceItems()
Method Detail |
---|
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
public void setOpenOrderStates(java.lang.String[] pOpenOrderStates)
public java.lang.String[] getOpenOrderStates()
public void setRemoveItemsWithDeletedProducts(boolean pRemoveItemsWithDeletedProducts)
public boolean isRemoveItemsWithDeletedProducts()
public boolean shouldOrderBeModified(Order pOrder)
pOrder
- - the order whose state is being checked.
public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
public void setRemovedSkuId(java.lang.String pRemovedSkuId)
public java.lang.String getRemovedSkuId()
public void setRemovedProductId(java.lang.String pRemovedProductId)
public java.lang.String getRemovedProductId()
public void setWarnOnNullOrderState(boolean pWarnOnNullOrderState)
public boolean isWarnOnNullOrderState()
public void setTreatNullOrderStateAsModifiable(boolean pTreatNullOrderStateAsModifiable)
public boolean isTreatNullOrderStateAsModifiable()
public boolean shouldItemBeRemoved(CommerceItem pCommerceItem)
pCommerceItem
- the item whose Product or Sku ids will be checked
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
PipelineProcessor
runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other data
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |