com.ibm.commerce.marketing.commands

Class AddOrderItemWithPromotionCodeOrCouponCmdImpl

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

com.ibm.commerce.marketing.commands.AddOrderItemWithPromotionCodeOrCouponCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AddOrderItemWithPromotionCodeOrCouponCmd, 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 AddOrderItemWithPromotionCodeOrCouponCmdImpl
extends OrderItemAddCmdImpl
implements AddOrderItemWithPromotionCodeOrCouponCmd

This Controller Command implementation adds a promotion code or coupon to an order by invoking the backend runtime promotion engine. It implements the AddOrderItemWithPromotionCodeOrCouponCmd interface. It is called in nested controller commands and redirects to page with different types of error messages in case there is an error in running this command.

• If partNumber or catEntryId parameters are set, then add the item to the customer's pending order. If partNumber or catEntryId parameters are not set, then only create a pending order if one does not currently exist.
• If the promoCode parameter is provided, then apply the promotion code to the pending order. Otherwise, if the promoName parameter is provided, then find the specified promotion, and issue a coupon to the customer associated with that promotion. Then apply the coupon to the customer's pending order.

See Also:

Serialized Form

Field Summary

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.marketing.commands.AddOrderItemWithPromotionCodeOrCouponCmd

defaultCommandClassName

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

badPartNumberErrorView, badPartNumberList, badPartNumberQuantityList, goodPartNumberList, goodPartNumberQuantityList, multiplePartNumberCatalogEntriesList, multiplePartNumberList, multiplePartNumberQuantityList, NAME

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

serialVersionUID

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

defaultCommandClassName, NAME

Constructor Summary

Constructors

Constructor and Description
AddOrderItemWithPromotionCodeOrCouponCmdImpl()

Method Summary

Modifier and Type	Method and Description
boolean	isReadyToCallExecute() Checks to see if this controller command is ready to be invoked
void	performExecute() This method is responsible for adding a promotion code to an order.
void	setGuestToken(java.lang.String aToken) Sets the string identifier of a guest customer.
void	setPromotionCode(java.lang.String pCode) Sets promotion code.
void	setPromotionName(java.lang.String pName) Sets promotion name.
void	setPromotionVersion(java.lang.Integer version) Sets promotion version.
void	setRequestProperties(TypedProperty aRequestProperties) Sets the request properties of the controller command.
void	validateParameters() This method verifies the input parameters.

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, getTheUserId, getTieShipCode, reset, 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, setFulfillmentCenterId, 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

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, 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, 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.OrderItemAddCmd

getNonBuyableCatentryIds, getOrderIds, getOrderItemIds, setAddressId, setAttrName, setAttrValue, setCatEntryId, setComment, setConfigurationId, setContinue, setContractId, setCorrelationGroup, setDescription, setExpandConfigurationId, setField1, setField2, setFulfillmentCenterId, setListId, setMemberId, setOfferId, setOrderComment, setOrderDesc, setOrderId, setOutOrderItemName, setOutOrderName, setPartNumber, setQuantity, 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, 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

reset

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

fulfills, getOwner

Constructor Detail

AddOrderItemWithPromotionCodeOrCouponCmdImpl

public AddOrderItemWithPromotionCodeOrCouponCmdImpl()

Method Detail

setPromotionCode

public void setPromotionCode(java.lang.String pCode)

Description copied from interface: AddOrderItemWithPromotionCodeOrCouponCmd

Sets promotion code. Needed when a promotion code is to be added to the current order

Specified by:

setPromotionCode in interface AddOrderItemWithPromotionCodeOrCouponCmd

Parameters:

pCode - the promotion code

See Also:

AddOrderItemWithPromotionCodeOrCouponCmd.setPromotionCode(java.lang.String)

setPromotionName

public void setPromotionName(java.lang.String pName)

Description copied from interface: AddOrderItemWithPromotionCodeOrCouponCmd

Sets promotion name. Needed when a coupon is to be issued to the customer and added to current order

Specified by:

setPromotionName in interface AddOrderItemWithPromotionCodeOrCouponCmd

Parameters:

pName - the name of the promotion

See Also:

AddOrderItemWithPromotionCodeOrCouponCmd.setPromotionName(java.lang.String)

setPromotionVersion

public void setPromotionVersion(java.lang.Integer version)

Description copied from interface: AddOrderItemWithPromotionCodeOrCouponCmd

Sets promotion version. Needed when a coupon is to be issued to the customer and added to current order

Specified by:

setPromotionVersion in interface AddOrderItemWithPromotionCodeOrCouponCmd

Parameters:

version - set the version for promotion. Promotions with different version numbers are considered different promotions. Among all the promotions with same name in the same store, only one is active at any given time. This one is identified by promotion name, version or revision numbers, and store ID. The rest of them will be marked as obsolete.

See Also:

AddOrderItemWithPromotionCodeOrCouponCmd.setPromotionVersion(java.lang.Integer)

setGuestToken

public void setGuestToken(java.lang.String aToken)

Description copied from interface: AddOrderItemWithPromotionCodeOrCouponCmd

Sets the string identifier of a guest customer. Needed when a coupon is to be issued to a guest customer.

Specified by:

setGuestToken in interface AddOrderItemWithPromotionCodeOrCouponCmd

Parameters:

aToken - the string identifier of the guest customer

See Also:

com.ibm.commerce.marketing.commands.AddOrderItemWithPromotionCodeOrCouponCmd#setGuestToken(java.lang.Integer)

isReadyToCallExecute

public boolean isReadyToCallExecute()

Checks to see if this controller command is ready to be invoked

Specified by:

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

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

true if this command is ready to be invoked, false otherwise

performExecute

public void performExecute()
                    throws ECException

This method is responsible for adding a promotion code to an order. If no code is specified, it is responsible for issuing a coupon to the customer and then adding it to the order so that the coupon can be used with the order.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class OrderItemBaseCmdImpl

Throws:

ECException - if an error is encountered.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECException

Sets the request properties of the controller command.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class OrderItemBaseCmdImpl

Parameters:

aRequestProperties - The request properties to set to the controller command, for example "promoCode".

Throws:

ECException - when an error is encountered on setting the request properties.

See Also:

ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException

This method verifies the input parameters. If the partNumber is not provided, then just set up the minimum amount of information to locate or create the order. Otherwise call the base class validateParameters method.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class OrderItemBaseCmdImpl

Throws:

ECException