com.ibm.commerce.order.commands

Interface OrderCalculateCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

ExternalOrderCalculateCmdImpl, OrderCalculateCmdImpl, PromotionEngineOrderCalculateCmdImpl, VATOrderCalculateCmdImpl, VATPromotionEngineOrderCalculateCmdImpl

public interface OrderCalculateCmd
extends ControllerCommand

This Order controller command is used to re-calculate specified calculation usages.
This command is called by OrderItemBaseCmdImpl and OrderItemDeleteCmdImpl to refresh the order price, charges and freebie items after Add, Update and Delete order item.
The default implementation of this command is OrderCalculateCmdImpl. But in out-of-the-box CMDREG table, the implementation of this command is mapped to PromotionEngineOrderCalculateCmdImpl.
The OrderCalculate URL is mapped to this controller command.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of this command.

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

serialVersionUID

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 identifiers of CatalogEntries that do not have sufficient inventory, when ATP inventory is not enabled.
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	setUsageIds(java.lang.Integer[] anUsageIds) This method sets the calculation usages.

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

isReadyToCallExecute, reset

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

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

Method Detail

setOrders

void setOrders(OrderAccessBean[] aabOrders)

This method sets the orders to be calculated.

Parameters:

aabOrders - the array of OrderAccessBeans to be calculated.

setUsageIds

void setUsageIds(java.lang.Integer[] anUsageIds)

This method sets the calculation usages.

Parameters:

anUsageIds - the array of calculation usage identifiers.

getOutOfInventoryCatalogEntryIds

java.lang.Long[] getOutOfInventoryCatalogEntryIds()

This method returns the identifiers of CatalogEntries that do not have sufficient inventory, when ATP inventory is not enabled.

Returns:

the array of CatalogEntry identifiers.

setCustomProperties

void setCustomProperties(java.util.HashMap newhshCustomProperties)

This method sets the customer properties.

Parameters:

newhshCustomProperties - the customer properties

getCustomProperties

java.util.HashMap getCustomProperties()

This method returns the customer properties.

Returns:

customer properties