com.ibm.commerce.orderitems.commands

Class AdminOrderItemUpdateCOCmdImpl

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.orderitems.commands.OrderItemBaseCmdImpl

com.ibm.commerce.orderitems.commands.OrderItemUpdateCmdImpl

com.ibm.commerce.orderitems.commands.AdminOrderItemUpdateCOCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AdminOrderItemUpdateCOCmd, OrderItemAddCmd, OrderItemUpdateCmd, 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

public class AdminOrderItemUpdateCOCmdImpl
extends OrderItemUpdateCmdImpl
implements AdminOrderItemUpdateCOCmd

This is the default implementation of the AdminOrderItemUpdateCOCmd controller command. It allows an administrator to manually add or update a price and currency for the order item instead of retrieving the price from catalog entry.

Input parameters:

It accepts all parameters for OrderItemUpdateCmdImpl, and below,

Name	Description
fulfillmentCenterId_i	Fulfillment center Id related to the enumeration group i, Optional
price_i	Price related to the enumeration group i, Optional
currency_i	Currency related to the enumeration group i, Optional, but if price_i is passed, it's mandatory
overrideReasonCode_i	Price override reason code to the enumeration group i, Optional
remark_i	Remark to the enumeration group i, Optional
forUserId	The for User Id, the owner Id of the order, Mandatory
contractId	The contract Id, the owner Id of the order, Optional

Output parameters:

Same as OrderItemUpdateCmdImpl

Behaviour:

This command is called by an administrator to manually add or update a price and currency for the order item. It is used instead of retrieving the price from catalog entry. Or override the fulfillment center for the order items. It extends the OrderItemUpdateCmdImpl and overrides the updateOrderItem and updatePrice of the super class. It support the price override reason code, and remark. OrderItemsCmdHelper.validatePrice(Integer, CommandContext, String, Long, Long, String) will be called to check if the new price is valid. The order will be blocked if the price override is not valid. Also business audit is supported for this price override.

See Also:

OrderItemBaseCmdImpl, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME The full name of this class.
static java.lang.String	COPYRIGHT The IBM copyright notice field.

Fields inherited from class com.ibm.commerce.orderitems.commands.OrderItemBaseCmdImpl

GENERATED_ORDERITEM, MANUAL_FULFILLMENT_CENTER, MANUAL_PRICE, NORMAL_ORDERITEM, STR_INVALID_INPUT_ERROR_VIEW

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

LOCAL

Fields inherited from interface com.ibm.commerce.orderitems.commands.AdminOrderItemUpdateCOCmd

defaultCommandClassName, NAME

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

serialVersionUID

Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemAddCmd

badPartNumberErrorView, defaultCommandClassName, NAME

Constructor Summary

Constructors

Constructor and Description
AdminOrderItemUpdateCOCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getForUserId() This method gets the for user id.
java.lang.Long	getNewTradingId() This method gets the trading id to be stored in OrderItem.
java.lang.Long	getTheUserId() This method returns user id.
void	reset() This method resets the instance variables.
void	setCurrency(java.util.Hashtable ahshCurrency) This method sets the currency.
void	setForUserId(java.lang.Long aForUserId) This method sets the for user id.
void	setFulfillmentCenterId(java.util.Hashtable ahshFulfillmentCenterId) This method sets the fulfillment center id to be stored in OrderItem.
void	setNewTradingId(java.lang.Long anTradingId) This method sets the trading id to be stored in OrderItem.
void	setPrice(java.util.Hashtable ahshPrice) This method sets the price.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the request properties.

Methods inherited from class com.ibm.commerce.orderitems.commands.OrderItemBaseCmdImpl

getATPParms, getCalculationUsageIds, getDeletedOrderItemCatEntryIds, getDeletedOrderItemIds, getIsExpedited, getNewOrderId, getNewOrderItemIds, getNonBuyableCatentryIds, getOrderField1, getOrderField2, getOrderField3, getOrderIds, getOrderItemIds, getOutOfInvItems, getRepriceOrderFlag, getResolvedRequestProperties, getResources, getTheUser, getTieShipCode, performExecute, setAddressId, setATPParms, setAttrName, setAttrValue, setCalculationUsageIds, setCarrAccntNum, setCatEntryId, setChargeTypes, setComment, setComp_priceLocks, setComp_prices, setComp_quantities, setCompListId, setConfiguration, setConfigurationId, setContinue, setContractId, setCorrelationGroup, setDescription, setDk_price, setDk_priceLock, setDoPrice, setExpandConfigurationId, setField1, setField2, setIsExpedited, setListId, setMemberId, setOfferId, setOrderComment, setOrderDesc, setOrderField1, setOrderField2, setOrderField3, setOrderId, setOrderItemId, setOutOrderItemName, setOutOrderName, setPartNumber, setPhysicalStoreId, setQuantity, setQuantity, setRepriceOrderFlag, setRequestedShipDate, setShipAsComplete, setShipInstructions, setShipmodeId, setTieShipCode, setTradingId, setUom, validateParameters

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

checkPermission, fulfills, getGeneric, getOwner, getRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, 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.orderitems.commands.OrderItemUpdateCmd

getDeletedOrderItemIds, getNewOrderItemIds, getOrderIds, getOrderItemIds, getOutOfInvItems, setAddressId, setAttrName, setAttrValue, setCatEntryId, setComment, setCompListId, setConfigurationId, setContinue, setContractId, setCorrelationGroup, setDescription, setExpandConfigurationId, setField1, setField2, setListId, setMemberId, setOfferId, setOrderComment, setOrderDesc, setOrderId, setOrderItemId, setOutOrderItemName, setOutOrderName, setPartNumber, setQuantity, setRequestedShipDate, setShipmodeId, setTradingId, setUom

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, 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, getResourceOwners, setAccCheck, 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

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

CLASS_NAME

public static final java.lang.String CLASS_NAME

The full name of this class.

Constructor Detail

AdminOrderItemUpdateCOCmdImpl

public AdminOrderItemUpdateCOCmdImpl()

Method Detail

getTheUserId

public java.lang.Long getTheUserId()

This method returns user id.

Overrides:

getTheUserId in class OrderItemBaseCmdImpl

Returns:

user id. if the parameter forUserId is set, return it. Otherwise return the user id in the session.

reset

public void reset()

This method resets the instance variables.

Specified by:

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

Overrides:

reset in class OrderItemBaseCmdImpl

setCurrency

public void setCurrency(java.util.Hashtable ahshCurrency)

This method sets the currency.

Specified by:

setCurrency in interface AdminOrderItemUpdateCOCmd

Parameters:

ahshCurrency - a hashtable of currency.

setForUserId

public void setForUserId(java.lang.Long aForUserId)

This method sets the for user id.

Specified by:

setForUserId in interface AccCommand

Specified by:

setForUserId in interface AdminOrderItemUpdateCOCmd

Overrides:

setForUserId in class ControllerCommandImpl

Parameters:

aForUserId - the for user id.

getForUserId

public java.lang.Long getForUserId()

This method gets the for user id.

Specified by:

getForUserId in interface AccCommand

Overrides:

getForUserId in class ControllerCommandImpl

Returns:

iForUserId.

setFulfillmentCenterId

public void setFulfillmentCenterId(java.util.Hashtable ahshFulfillmentCenterId)

This method sets the fulfillment center id to be stored in OrderItem.

Specified by:

setFulfillmentCenterId in interface OrderItemAddCmd

Specified by:

setFulfillmentCenterId in interface OrderItemUpdateCmd

Overrides:

setFulfillmentCenterId in class OrderItemBaseCmdImpl

Parameters:

ahshFulfillmentCenterId - a hashtable of fulfillment center id.

setPrice

public void setPrice(java.util.Hashtable ahshPrice)

This method sets the price.

Specified by:

setPrice in interface AdminOrderItemUpdateCOCmd

Parameters:

ahshPrice - a hashtable of price

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECException

This method sets the request properties. It calls super.setRequestProperties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class OrderItemBaseCmdImpl

Parameters:

aRequestProperties - request properties.

Throws:

ECException - the exception is thrown if the super.setRequestProperties throws the exception.

setNewTradingId

public void setNewTradingId(java.lang.Long anTradingId)

This method sets the trading id to be stored in OrderItem.

Parameters:

anTradingId - the trading id to be stored in OrderItem.

getNewTradingId

public java.lang.Long getNewTradingId()

This method gets the trading id to be stored in OrderItem.

Returns:

inTradingId, the trading id to be stored in OrderItem.