com.ibm.commerce.orderitems.commands

Class OrderItemDeleteCmdImpl

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

All Implemented Interfaces:

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

QuoteItemDeleteCmdImpl

public class OrderItemDeleteCmdImpl
extends OrderBaseCmdImpl
implements OrderItemDeleteCmd

This is the default implementation of the OrderItemDeleteCmd controller command.

Input parameters:

Name	Description
orderItemId	The orderitem Ids, the order items to be deleted. Mandatory if catEntryId is not specified.
catEntryId	The catalog entry Ids, to which the order items to be deleted. Mandatory if orderItemId is not specified.
orderId	The order Ids. Mandatory if orderItemId is not specified.
outOrderName	The names of name-value pairs to add to the redirection URL. The values of the added name-value pairs are the reference numbers of the input orders. Optional.
calculateOrder	If order will be recalculated after some order items are removed. The values can be 1 for recalculate or 0 for not recalculate. Default value is 0

Output parameters:

Name	Description
The value for outOrderName[i]	The array of order Ids.
orderId	If outOrderName is empty, used as outOrderName.

Behaviour:

• For each of the order items to be deleted, the command does the following if orderItemId is specified:
  • Obtains the order that the order item is associated with.
  • If the order is in pending state, unlocks it and updates the timestamp.
  • Deletes the order items.
• The command does the following if catEntryId is specified:
  • Compiles the list of orders for processing.
    The ResolveOrdersCmd task command is invoked to obtain the current pending orders, if needed.
  • Does the following for each order in the list:
    • If the order is in pending state and the order items for the order contain the specified product, unlocks the order and updates the timestamp.
    • Deletes all the order items that contain the specified product.
• The command will call OrderCalculateCmd to calculate the whole if the passed parameter calculateOrder=1 for calculation usage CalculationConstants.USAGE_DISCOUNT

View Task: RedirectView

This command uses the following AccessBeans:

• OrderAccessBean
• OrderItemAccessBean

See Also:

OrderCalculateCmd, ResolveOrdersCmd, 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.orderitems.commands.OrderItemDeleteCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OrderItemDeleteCmdImpl() Default constructor

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() Gets the resources.
void	performExecute() The main entry point of the command.
void	reset() Reset all instance variables.
void	setCatEntryId(java.lang.String[] ids) set a list of catalog entry ids to be deleted from the pending orders specified by orderId.
void	setOrderId(java.lang.String[] numbers) Specifies zero or more orders, using order ids or one of the special abbreviations ".", "*", ".t", "*t".
void	setOrderItemId(java.lang.String[] numbers) Set an array of id of order items to be deleted.
void	setOutOrderName(java.lang.String[] names) Specifies the names of name-value pairs to add to the redirection URL.
void	setRequestProperties(TypedProperty aRequestProperties) Sets the request properties.
void	validateParameters() Verify the input parameters.

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

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

OrderItemDeleteCmdImpl

public OrderItemDeleteCmdImpl()

Default constructor

Method Detail

getResources

public AccessVector getResources()
                          throws ECException

Gets the resources.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

resource access vector

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

The main entry point of the command.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

Reset all instance variables.

Specified by:

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

Overrides:

reset in class AbstractECTargetableCommand

setCatEntryId

public void setCatEntryId(java.lang.String[] ids)

set a list of catalog entry ids to be deleted from the pending orders specified by orderId. This parameter is mandatory if orderItemId is not set. This parameter is ignored if orderItemId is set.

Specified by:

setCatEntryId in interface OrderItemDeleteCmd

Parameters:

ids - an array of catalog entry ids.

setOrderId

public void setOrderId(java.lang.String[] numbers)

Specifies zero or more orders, using order ids or one of the special abbreviations ".", "*", ".t", "*t". See OrderItem Commands for a description of these abbreviations. If this parameter is omitted, it defaults to "."

Specified by:

setOrderId in interface OrderItemDeleteCmd

Parameters:

numbers - an array of order ids.

setOrderItemId

public void setOrderItemId(java.lang.String[] numbers)

Set an array of id of order items to be deleted.

Specified by:

setOrderItemId in interface OrderItemDeleteCmd

Parameters:

numbers - an array of order item ids.

setOutOrderName

public void setOutOrderName(java.lang.String[] names)

Specifies the names of name-value pairs to add to the redirection URL. The values of the added name-value pairs are the reference numbers of the input orders.

Specified by:

setOutOrderName in interface OrderItemDeleteCmd

Parameters:

names - an array of out order names.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException

Sets the request properties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

aRequestProperties - request properties.

Throws:

ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException

Verify the input parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException