com.ibm.commerce.orderitems.commands
Interface OrderItemDeleteCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- OrderItemDeleteCmdImpl
- public interface OrderItemDeleteCmd
- extends ControllerCommand
Deletes a product from one or more pending orders.
Behavior
- 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.
View Task: RedirectView
Method Summary |
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[] ids)
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. |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
NAME
public static final java.lang.String NAME
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.
setOrderId
public void setOrderId(java.lang.String[] ids)
- 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
"."
setOrderItemId
public void setOrderItemId(java.lang.String[] numbers)
- Set an array of id of order items to be deleted.
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.