com.ibm.commerce.orderitems.commands
Interface OrderItemDeleteCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
OrderItemDeleteCmdImpl

public interface OrderItemDeleteCmd
extends ControllerCommand

Deletes a product from one or more pending orders.

Behavior

View Task: RedirectView


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String NAME
          The name of the Command Interface class.
 
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
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values
Method Detail

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.
Parameters:
ids - an array of catalog entry ids.

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 "."
Parameters:
ids - an array of order ids.

setOrderItemId

public void setOrderItemId(java.lang.String[] numbers)
Set an array of id of order items to be deleted.
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.