com.ibm.commerce.order.commands

Class OrderPrepareCmdImpl

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

com.ibm.commerce.order.commands.OrderPrepareCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderPrepareCmd, 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:

GiftRegistryOrderPrepareCmdImpl

public class OrderPrepareCmdImpl
extends OrderPrepareBaseImpl
implements OrderPrepareCmd

This is the default implementation of the controller command OrderPrepareCmd. It prepares the specified orders for display (by the OrderDisplayCmd) or processing (by the OrderProcessCmd). If no order numbers are specified, then the command prepares all the current pending orders of the current customer that belong to the specified store.

Input parameters:

*

Name	Description
URL	optional, the URL to be called when the command completes successfully.
orderId	optional, the order Id specified, this parameter can be repeated.
outOrderName	Specifies the names of name-value pairs to be added to the redirection URL.
retainOrderCurrency	The currency to be retained.

Output parameters:

Name	Description
warningErrorMessageKey	return this parameter if shopping cart has changed, _WARNING_ORDER_PREPARE_AN_ITEM_IN_PRE_SHIPPING_MODE
warningErrorMessage	return this parameter if shopping cart has changed, the ECMessage of key WARNING_ORDER_PREPARE_AN_ITEM_IN_PRE_SHIPPING_MODE

Behaviour:

• If the value of the commit parameter is 1, a new database transaction is started for every order to be prepared. Otherwise, all orders are prepared in one transaction (the default behavior).
• Check whether the order is in the correct status. The status of the specified orders must be P, I, E, W, or N.
• Call ValidateShippingAdjustmentCmd to validate that the order hasn't changed since a shipping adjustment was added.
• Call the PrepareOrderCmd task command to do pricing, calculation and inventory actions.

Task commands called:

• ValidateShippingAdjustmentCmd
• PrepareOrderCmd

AccessBeans used:

• OrderAccessBean
• OrderItemAccessBean

Possible callers:

• CompleteOrderCmdImpl
• OrderDisplayCmdImpl
• SalesOrderPreprocessCmdImpl
• ScheduledOrderProcessCmdImpl
• RFQToOrderCreateCmdImpl
• RequisitionListSubmitCmdImpl
• CSROrderPrepareImpl
• RFQCompleteCmdImpl

See Also:

Serialized Form

Field Summary

Fields

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

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

LOCAL

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

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OrderPrepareCmdImpl()

Method Summary

Modifier and Type	Method and Description
boolean	getCommit() This method returns the commit flag
void	performExecute() This method contains the actual business logic of the command.
void	reset() This method should be called after a command has been executed to reset its states variables.
void	setCommit(boolean aCommit) This method sets the commit flag to control whether each order is processed in a separate database transaction
void	setRequestProperties(TypedProperty aReqParms) The WebController calls the setRequestProperties method before invoking the execute method in this command.
void	validateParameters() This method performs server side parameter checking.

Methods inherited from class com.ibm.commerce.order.commands.OrderPrepareBaseImpl

addOrderRn, checkPendingOrderParameters, getATPParms, getMerchantNumber, getMerchantRn, getOrderProcessingUtility, getOrderRn, getOutOrderIds, getPage, getResources, getRetainCurrency, getStatus, getUrl, setATPParms, setMerchantNumber, setMerchantRn, setOrderId, setOrderProcessingUtility, setOutOrderIds, setPage, setRetainCurrency, setStatus, setUrl

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.order.commands.OrderPrepareCmd

setOrderId, setOutOrderIds

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

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

OrderPrepareCmdImpl

public OrderPrepareCmdImpl()

Method Detail

performExecute

public void performExecute()
                    throws ECException

This method contains the actual business logic of the command. It calls checkStatus(OrderAccessBean) to verify the status of the order. It then checks to see if the Order was generated from a Quote. If so, check if the Quote is still within its expire date. If not, calls resetSkipRepricingPrepareFlagsForOrder(OrderAccessBean) to reset all the SKIP_REPRICING prepare flags for the items. Then it calls ValidateShippingAdjustmentCmd to validate that the order hasn't changed since a shipping adjustment was added. Finally it calls the PrepareOrderCmd task command to do pricing, calculation and inventory actions.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class OrderPrepareBaseImpl

Throws:

ECException

setRequestProperties

public void setRequestProperties(TypedProperty aReqParms)
                          throws ECApplicationException

The WebController calls the setRequestProperties method before invoking the execute method in this command.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class OrderPrepareBaseImpl

Parameters:

aReqParms - request properties.

Throws:

ECApplicationException

reset

public void reset()

This method should be called after a command has been executed to reset its states variables.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

getCommit

public boolean getCommit()

This method returns the commit flag

Returns:

Returns a boolean

setCommit

public void setCommit(boolean aCommit)

This method sets the commit flag to control whether each order is processed in a separate database transaction

Specified by:

setCommit in interface OrderPrepareCmd

Parameters:

aCommit - The ibCommit to set

validateParameters

public void validateParameters()
                        throws ECException

This method performs server side parameter checking.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException