PromotionEngineOrderCalculateCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.order.commands.PromotionEngineOrderCalculateCmdImpl

All Implemented Interfaces:: AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderCalculateCmd, Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:: ExternalOrderCalculateCmdImpl, VATPromotionEngineOrderCalculateCmdImpl

public class PromotionEngineOrderCalculateCmdImpl
extends ControllerCommandImpl
implements OrderCalculateCmd

This is the Promotion Engine base implementation of the OrderCalculateCmd controller command.

Input parameters:

Name	Description
`orderId`	The reference number of the order to be displayed. If this parameter is omitted, this command behaves as if all of the customer's orders with the specified status for the specified store were specified. Abbreviations may be used, but only with pending orders (status is P for standard orders or NEW for advanced orders). This parameter can be repeated.
`calculationUsageId`	Predefined codes for calculation of discounts (-1), shipping (-2), sales tax (-3), shipping tax (-4), coupons (-5), surcharge (-6), shipping adjustment (-7). This parameter can be repeated.
`outOrderName`	Specifies the names of name-value pairs to be passed to a JSP. The value of each added name-value pair is the reference number of the order to be displayed. If the name is not provided, the default name `orderId` is used. This parameter can be repeated.
`calculationUsageId`	Predefined codes for calculation of discounts (-1), shipping (-2), sales tax (-3), shipping tax (-4), coupons (-5), surcharge (-6), shipping adjustment (-7). This parameter can be repeated.
`updatePrices`	This flag indicates whether the prices of order items will be refreshed in this command. If the value of the flag is set to "0" (default value), then the prices will not be refreshed. If the value of the flag is set to "1", then the prices will be updated.
`keepAutoAddedOrderItemsBeforeCalculate`	This flag indicates whether the `freegift` item should be kept in the order before calculating discounts. If the value of the flag is "0" (default value), the `freegift` item will be removed before calculating discounts and then re-added. If the value of the flag is "1", the `freegift` item will be kept as is.

Output parameters:

Name	Description
istrOutOrderNames	the order IDs to be displayed
`outOfInventoryCatalogEntryId`	the catalog entrys which are intended to add to the order as `freegift` but has no inventory now.
`nonBuyableCatalogEntryId`	the catalog entrys which are intended to add to the order as `freegift` but are non-buyable now.

Behavior:

For each Order specified:

unlock the Order
initialize the specified CalculationUsages that are enabled
if the PromotionsEngine component is enabled and freegift is to be refreshed. Call the PromotionEngine to obtain a list of CatalogEntries to add to the Order
for each CatalogEntry to be added to the Order, if ATP is disabled and there is insufficient inventory:
- remove the CatalogEntry from the list
- add the CatalogEntry identifier to the outOfInventoryCatalogEntryId list
call the OrderItemAddCmd controller command to add the CatalogEntries to the Order
call ResolveOrderItemPriceCmd to update the product total of the Order and its OrderItems
apply the specified CalculationUsages that are enabled
update the SubOrders for the Order unless that feature is disabled
summarize the specified CalculationUsages that are enabled
Finally, call the method setResponseProperties() .

Task commands called:

AccessBeans utilized:

Possible callers:

RewardChoiceUpdateCmdImpl
SalesOrderPreprocessCmdImpl
GuestUserOrderMigrationEventListener
OrderItemAddCmdImpl
OrderItemUpdateCmdImpl
OrderItemDeleteCmdImpl
MigrateRegisteredUserEntriesCmdImpl
CSROrderPrepareCmdImpl

See Also:: OrderCalculateCmdImpl

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.
- Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
  requestProperties, responseProperties, retriable, viewReqProperties
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.order.commands.OrderCalculateCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

PromotionEngineOrderCalculateCmdImpl()
Constructor for PromotionEngineOrderCalculateCmdImpl.

Constructors
Constructor and Description
`PromotionEngineOrderCalculateCmdImpl()` Constructor for PromotionEngineOrderCalculateCmdImpl.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addCatalogEntriesToOrder(OrderAccessBean aabOrder, java.util.Map mapCatalogEntryQuantitiesToAdd)` This method calls `OrderItemAddCmd` to add the specified Map of CatalogEntries and their quantities to the specified Order.
`protected void`	`copyFreeGiftAttributes(java.lang.String[] targetItemIds, java.util.ArrayList originalAutoAddedOrderItems)` This method is to copy the attributes of the original free gift to the new free gift item.
`protected java.util.Map`	`getCatalogEntryQuantitiesToAdd(OrderAccessBean aabOrder, java.util.HashMap ahshCustomProperties)` This method invokes Promotion Engine and returns the CatalogEntries to add to the Order and their quantities.
`java.util.HashMap`	`getCustomProperties()` This method returns the customer properties.
`protected java.util.Map`	`getFreebies(Adjustment[] adjustments)` This method returns the freebies in the specified `adjustments`.
`protected OrderItemAccessBean[]`	`getOrderItems(OrderAccessBean aabOrder)` This method returns the OrderItems of the specified Order.
`protected OrderAccessBean[]`	`getOrders()` This method returns the Orders specified to be processed by this command.
`java.lang.Long[]`	`getOutOfInventoryCatalogEntryIds()` This method returns the CatalogEntry identifiers of catalog items that could not be added to the Order due to insufficient inventory.
`protected java.util.Set`	`getOutOfInventoryCatalogEntryIds(java.util.Map mapCatalogEntryQuantitiesToAdd)` This method returns a Set of CatalogEntryIds that are out of inventory in the specified Map of freebies ( CatalogEntries/quantities )
`protected boolean`	`getRemoveOutOfInventoryFreeGift()` Get the settings for if out-of-inventory free gifts should be removed from cart.
`AccessVector`	`getResources()` This method returns an `AccessVector` containing the `OrderAccessBean`s to be processed.
`protected java.util.Date`	`getTime()` This method returns appropriate date.
`protected java.lang.Integer[]`	`getUsageIds()` This method returns the CalculationUsages specified to be recalculated by this command.
`protected PromotionArgument`	`invokePromotionEngine(java.lang.String template, java.lang.Long orderId, boolean discardPreviousResult, boolean saveCurrentResult, java.util.Hashtable nameValuePair)` This method returns the PromotionArgument as a result of invoking the Promotions Engine.
`void`	`performExecute()` This method executes the main business logic of the command implementation.
`protected OrderItemAccessBean[]`	`removeAutoAddedOrderItems(OrderItemAccessBean[] abOrderItems)` This method removes the auto-added order items.
`void`	`reset()` This method resets instance variables to their initial values.
`void`	`setCustomProperties(java.util.HashMap newhshCustomProperties)` This method sets the customer properties.
`void`	`setOrders(OrderAccessBean[] aabOrders)` This method sets the orders to be calculated.
`protected void`	`setOutOfInventoryCatalogEntryIds(java.lang.Long[] anOutOfInventoryCatalogEntryIds)` This method sets the CatalogEntries that are out of inventory.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` This method sets the request properties to the command.
`protected void`	`setResponseProperties()` This method sets the response properties: For each name that was specified by the outOrderName request property, add a response property with that name.
`void`	`setUsageIds(java.lang.Integer[] anUsageIds)` This method sets the calculation usage ids.
`protected void`	`updateOrderItemProductTotal(OrderItemAccessBean aabOrderItem, java.lang.String astrCurrency)` This method updates the product total of the specified OrderItem.
`protected void`	`updateOrderProductTotal(OrderAccessBean aabOrder, OrderItemAccessBean[] aabOrderItems)` This method calls `ResolveOrderItemPriceCmd` to calculate prices and update the product total of the specified Order and OrderItems.
`void`	`validateParameters()` This method calls `ResolveOrdersCmd` to resolve the orders to be processed from the request.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PromotionEngineOrderCalculateCmdImpl
```
public PromotionEngineOrderCalculateCmdImpl()
```
    Constructor for PromotionEngineOrderCalculateCmdImpl.
- Method Detail
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method executes the main business logic of the command implementation.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
    
    See Also:
    
    ECCommand.performExecute()
  - getCatalogEntryQuantitiesToAdd
```
protected java.util.Map getCatalogEntryQuantitiesToAdd(OrderAccessBean aabOrder,
                                           java.util.HashMap ahshCustomProperties)
                                                throws ECException
```
    This method invokes Promotion Engine and returns the CatalogEntries to add to the Order and their quantities.
    Parameters:
    
    aabOrder - the Order.
    
    ahshCustomProperties - the custom properties.
    
    Returns:
    the CatalogEntries and their quantities.
    
    Key: CatalogEntry identifier (Long).
    
    Value: quantity (Double).
    Throws:
    
    ECException
  - setOrders
```
public void setOrders(OrderAccessBean[] aabOrders)
```
    This method sets the orders to be calculated.
    
    Specified by:
    
    setOrders in interface OrderCalculateCmd
    
    Parameters:
    
    aabOrders - the Orders.
    
    See Also:
    
    OrderCalculateCmd.setOrders(OrderAccessBean[])
  - setUsageIds
```
public void setUsageIds(java.lang.Integer[] anUsageIds)
```
    This method sets the calculation usage ids.
    
    Specified by:
    
    setUsageIds in interface OrderCalculateCmd
    
    Parameters:
    
    anUsageIds - the CalculationUsage identifiers.
    
    See Also:
    
    OrderCalculateCmd.setUsageIds(Integer[])
  - setOutOfInventoryCatalogEntryIds
```
protected void setOutOfInventoryCatalogEntryIds(java.lang.Long[] anOutOfInventoryCatalogEntryIds)
```
    This method sets the CatalogEntries that are out of inventory.
    
    Parameters:
    
    anOutOfInventoryCatalogEntryIds - the CatalogEntry identifiers.
  - setCustomProperties
```
public void setCustomProperties(java.util.HashMap newhshCustomProperties)
```
    This method sets the customer properties.
    
    Specified by:
    
    setCustomProperties in interface OrderCalculateCmd
    
    Parameters:
    
    newhshCustomProperties - the customer properties
  - getOrders
```
protected OrderAccessBean[] getOrders()
```
    This method returns the Orders specified to be processed by this command.
    
    Returns:
    
    the Orders.
  - getUsageIds
```
protected java.lang.Integer[] getUsageIds()
```
    This method returns the CalculationUsages specified to be recalculated by this command.
    
    Returns:
    
    the CalculationUsage identifiers.
  - getOutOfInventoryCatalogEntryIds
```
public java.lang.Long[] getOutOfInventoryCatalogEntryIds()
```
    This method returns the CatalogEntry identifiers of catalog items that could not be added to the Order due to insufficient inventory.
    
    Specified by:
    
    getOutOfInventoryCatalogEntryIds in interface OrderCalculateCmd
    
    Returns:
    
    the CatalogEntry identifiers of catalog items that could not be added to the Order due to insufficient inventory.
    
    See Also:
    
    OrderCalculateCmd.getOutOfInventoryCatalogEntryIds()
  - getCustomProperties
```
public java.util.HashMap getCustomProperties()
```
    This method returns the customer properties.
    
    Specified by:
    
    getCustomProperties in interface OrderCalculateCmd
    
    Returns:
    
    HashMap the customer properties
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECException
```
    This method sets the request properties to the command.
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    aRequestProperties - the request properties.
    
    The following request properties are recognized:
    
    orderId an array of Order abbreviations that specify Orders to be processed.
    
    calculationUsageId an array of CalculationUsage identifiers.
    
    outOrderName an array of names to be added to the response properties. The values for each name are the identifiers of the specified Orders.
    Throws:
    
    ECApplicationException - The _ERR_BAD_MISSING_CMD_PARAMETER message is passed, with the name of the invalid or missing property name.
    
    ECException -
    
    See Also:
    
    ControllerCommand.setRequestProperties(TypedProperty)
  - getOrderItems
```
protected OrderItemAccessBean[] getOrderItems(OrderAccessBean aabOrder)
                                       throws ECException
```
    This method returns the OrderItems of the specified Order.
    
    Parameters:
    
    aabOrder - the Order.
    
    Returns:
    
    the OrderItems.
    
    Throws:
    
    ECException
  - invokePromotionEngine
```
protected PromotionArgument invokePromotionEngine(java.lang.String template,
                                      java.lang.Long orderId,
                                      boolean discardPreviousResult,
                                      boolean saveCurrentResult,
                                      java.util.Hashtable nameValuePair)
                                           throws ECException
```
    This method returns the PromotionArgument as a result of invoking the Promotions Engine.
    
    Parameters:
    
    template - - the invoking Template.
    
    orderId - - the orderId of the Order for which the promotions are to be evaluated.
    
    discardPreviousResult - - boolean specifying if the promotions engine should discard previous results.
    
    saveCurrentResult - - boolean specifying if the promotions engine should save the current results..
    
    nameValuePair - - the Hashtable containing extra parameters,if any, for the promotions Engine. Current command context set by default unless overridden.
    
    Returns:
    
    the PromotionArgument.
    
    Throws:
    
    ECException
  - getFreebies
```
protected java.util.Map getFreebies(Adjustment[] adjustments)
                             throws ECSystemException
```
    This method returns the freebies in the specified adjustments.
    Parameters:
    
    adjustments - - the adjustments array.
    
    Returns:
    
    the map of freebies.
    
    Throws:
    ECSystemException -
    
    Key: CatalogEntry identifier (Long).
    
    Value: quantity (Double).
  - getOutOfInventoryCatalogEntryIds
```
protected java.util.Set getOutOfInventoryCatalogEntryIds(java.util.Map mapCatalogEntryQuantitiesToAdd)
                                                  throws ECException
```
    This method returns a Set of CatalogEntryIds that are out of inventory in the specified Map of freebies ( CatalogEntries/quantities )
    Parameters:
    mapCatalogEntryQuantitiesToAdd - the CatalogEntries and their quantities (Map).
    
    Key: CatalogEntry identifier (Long).
    
    Value: quantity (Double).
    Returns:
    
    the Set of CatalogEntry identifiers (Set of Long).
    
    Throws:
    
    ECException
  - addCatalogEntriesToOrder
```
protected void addCatalogEntriesToOrder(OrderAccessBean aabOrder,
                            java.util.Map mapCatalogEntryQuantitiesToAdd)
                                 throws ECException
```
    This method calls OrderItemAddCmd to add the specified Map of CatalogEntries and their quantities to the specified Order.
    Parameters:
    
    aabOrder - the Order.
    mapCatalogEntryQuantitiesToAdd - the CatalogEntries and their quantities.
    
    Key: CatalogEntry identifier (Long).
    
    Value: quantity (Double).
    Throws:
    
    ECException
  - updateOrderItemProductTotal
```
protected void updateOrderItemProductTotal(OrderItemAccessBean aabOrderItem,
                               java.lang.String astrCurrency)
                                    throws ECException
```
    This method updates the product total of the specified OrderItem.
    
    Parameters:
    
    aabOrderItem - the OrderItem.
    
    astrCurrency - the Order currency.
    
    Throws:
    
    ECException
  - updateOrderProductTotal
```
protected void updateOrderProductTotal(OrderAccessBean aabOrder,
                           OrderItemAccessBean[] aabOrderItems)
                                throws ECException
```
    This method calls ResolveOrderItemPriceCmd to calculate prices and update the product total of the specified Order and OrderItems.
    
    Parameters:
    
    aabOrder - the Order.
    
    aabOrderItems - the OrderItems.
    
    Throws:
    
    ECException
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method calls ResolveOrdersCmd to resolve the orders to be processed from the request.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
    
    See Also:
    
    ECCommand.validateParameters()
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    This method returns an AccessVector containing the OrderAccessBeans to be processed.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    the AccessVector.
    
    Throws:
    
    ECException
    
    See Also:
    
    ECCommand.getResources()
  - setResponseProperties
```
protected void setResponseProperties()
                              throws ECException
```
    This method sets the response properties:
    - For each name that was specified by the outOrderName request property, add a response property with that name. The values of the added response property are the identifiers of the Orders processed by this command.
    - If ATP inventory is not enabled, and add a response property outOfInventoryCatalogEntryId. Its values are the identifiers of the CatalogEntries that could not be added to the Order due to insufficient inventory.
    - If some items intended to add into the order are set as non buyable, add a response property named nonBuyableCatalogEntryId. Its values are the identifiers of the CatalogEntries that are non buyable.
    - The viewTaskName property is added. It's value is set to "RedirectView".
    Throws:
    
    ECException
  - reset
```
public void reset()
```
    This method resets instance variables to their initial values.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
  - getTime
```
protected java.util.Date getTime()
```
    This method returns appropriate date. It first look in the request properties of the command text. If not found, in preview mode it returns user specified preview date, current date otherwise. It can be customized to return the order place date. This way the promotions that are active when the order is placed and can be used to calculate the total.
    
    Returns:
    
    User specified date in command text, then preview date if in preview mode, current date otherwise.
  - removeAutoAddedOrderItems
```
protected OrderItemAccessBean[] removeAutoAddedOrderItems(OrderItemAccessBean[] abOrderItems)
                                                   throws ECException
```
    This method removes the auto-added order items.
    
    Parameters:
    
    abOrderItems - an array of order items.
    
    Returns:
    
    OrderItemsAccessBean[] an array of order items after deletion.
    
    Throws:
    
    ECException
  - copyFreeGiftAttributes
```
protected void copyFreeGiftAttributes(java.lang.String[] targetItemIds,
                          java.util.ArrayList originalAutoAddedOrderItems)
                               throws ECException
```
    This method is to copy the attributes of the original free gift to the new free gift item.
    
    Parameters:
    
    targetItemIds -
    
    originalAutoAddedOrderItems -
    
    Throws:
    
    ECException
  - getRemoveOutOfInventoryFreeGift
```
protected boolean getRemoveOutOfInventoryFreeGift()
                                           throws ECException
```
    Get the settings for if out-of-inventory free gifts should be removed from cart.
    
    Returns:
    
    the settings for if out-of-inventory free gifts should be removed from cart.
    
    Throws:
    
    ECException

Class PromotionEngineOrderCalculateCmdImpl

Input parameters:

Output parameters:

Behavior:

Task commands called:

AccessBeans utilized:

Possible callers:

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.order.commands.OrderCalculateCmd

Fields inherited from interface com.ibm.websphere.command.Command

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.commerce.security.Protectable

Field Detail

COPYRIGHT

Constructor Detail

PromotionEngineOrderCalculateCmdImpl

Method Detail

performExecute

getCatalogEntryQuantitiesToAdd

setOrders

setUsageIds

setOutOfInventoryCatalogEntryIds

setCustomProperties

getOrders

getUsageIds

getOutOfInventoryCatalogEntryIds

getCustomProperties

setRequestProperties

getOrderItems

invokePromotionEngine

getFreebies

getOutOfInventoryCatalogEntryIds

addCatalogEntriesToOrder

updateOrderItemProductTotal

updateOrderProductTotal

validateParameters

getResources

setResponseProperties

reset

getTime

removeAutoAddedOrderItems

copyFreeGiftAttributes

getRemoveOutOfInventoryFreeGift