com.ibm.commerce.order.commands

Class OrderCalculateCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.order.commands.OrderBaseCmdImpl

com.ibm.commerce.order.commands.OrderCalculateCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderCalculateCmd, Protectable, com.ibm.websphere.cache.Sizeable, 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:

VATOrderCalculateCmdImpl

public class OrderCalculateCmdImpl
extends OrderBaseCmdImpl
implements OrderCalculateCmd

This is one of the implementations 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.
updatePrices	the flag to indicate whether the price of order item will be refreshed in this command. if the flag is "1", price will be updated. others will not.
doPrice	Specifies whether the command should perform the price calculation subtasks. Set to either do the price tasks (Y), or not (N). Turning off these tasks might result in better performance, but customers might not get the most current price, or product entitlement, when changes occur.
doFreeGift	Specifies whether the command should perform the free gift handling logic. Set to either do the free gift handling (Y), or not (N). The default value is (Y). Only set it to (N) when free gift processing isn't required for Order recalculation.

Output parameters:

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

Behaviour:

For each Order specified:

• Unlocks the order.
• If updatePrices is 1, calls ResolveOrderItemPriceCmd to resolve price and updates order product totals.
• Calls CalculateOrderCmd to recalculates the order.

Returns a list of identifiers of catalog entries, if any, that were not added because of insufficient inventory.

Task commands called:

• ResolveOrdersCmd
• ResolveFulfillmentCenterCmd
• ResolveOrderItemPriceCmd
• CalculateOrderCmd
• OrderItemAddCmd

AccessBeans utilized:

• OrderAccessBean
• OrderItemAccessBean

Possible callers:

• RewardChoiceUpdateCmdImpl
• SalesOrderPreprocessCmdImpl
• GuestUserOrderMigrationEventListener
• OrderItemAddCmdImpl
• OrderItemUpdateCmdImpl
• OrderItemDeleteCmdImpl
• MigrateRegisteredUserEntriesCmdImpl
• CSROrderPrepareCmdImpl

See Also:

Serialized Form

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.websphere.command.TargetableCommandImpl

LOCAL

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

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OrderCalculateCmdImpl() Constructor for OrderCalculateCmdImpl.

Method Summary

Modifier and Type	Method and Description
java.util.HashMap	getCustomProperties() This method returns the customer properties.
java.lang.Long[]	getOutOfInventoryCatalogEntryIds() This method returns the list of catEntryIds of the items that are out of inventory.
AccessVector	getResources() Returns an AccessVector containing the OrderAccessBeans to be processed.
void	performExecute() This method executes the main business logic of the command implementation.
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.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the request properties.
void	setUsageIds(java.lang.Integer[] anUsageIds) This method sets the calculation usages.
void	validateParameters() 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 com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, 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

OrderCalculateCmdImpl

public OrderCalculateCmdImpl()

Constructor for OrderCalculateCmdImpl.

Method Detail

setOrders

public void setOrders(OrderAccessBean[] aabOrders)

Description copied from interface: OrderCalculateCmd

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 usages.

Specified by:

setUsageIds in interface OrderCalculateCmd

Parameters:

anUsageIds - the CalculationUsage identifiers.

See Also:

OrderCalculateCmd.setUsageIds(Integer[])

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

getOutOfInventoryCatalogEntryIds

public java.lang.Long[] getOutOfInventoryCatalogEntryIds()

This method returns the list of catEntryIds of the items that are out of 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

getResources

public AccessVector getResources()
                          throws ECException

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

validateParameters

public void validateParameters()
                        throws ECException

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

performExecute

public void performExecute()
                    throws ECException

This method executes the main business logic of the command implementation. It calls updateOrderProductTotal(OrderAccessBean, OrderItemAccessBean[]) to refresh the order product total. Then it calls CalculateOrderCmd to do calculation for the order.

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

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECException

This method sets the request properties.

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:

ECException -

See Also:

ControllerCommand.setRequestProperties(TypedProperty)

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