com.ibm.commerce.orderitems.commands
Interface OrderItemDisplayCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- OrderItemDisplayCmdImpl
- public interface OrderItemDisplayCmd
- extends ControllerCommand
Display a list of order items with pending order status.
Behavior
If the addressId is set, the command only displays order items with
this shipping address.
For each order item in the list, the command does the following:
- Check the address and update it if it is a temporary address.
- Call CheckInventoryCmd.
- Call GetBaseUnitPriceCmd to update the price.
View Task
If the addressId is set, it calls OrderItemDisplayViewShiptoDsp
view task, otherwise it calls OrderItemDisplayViewShiptoAssoc view task.
Method Summary |
void |
setAddressId(java.lang.Long addressId)
Sets the id of the address book entry for the items to display (optional). |
void |
setOrderId(java.lang.String[] orderId)
Specifies zero or more order ids (optional). |
void |
setOutOrderName(java.lang.String[] names)
Specifies the names of the name-value pairs to be added to the
response object passed to the command's view task. |
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
setAddressId
public void setAddressId(java.lang.Long addressId)
- Sets the id of the address book entry for the items to display (optional).
setOrderId
public void setOrderId(java.lang.String[] orderId)
- Specifies zero or more order ids (optional).
The order ids can be numbers or one of the
special abbreviations ".", "*", ".t", "*t".
See OrderItem Commands for a
description of these abbreviations.
If this parameter is omitted, the default is "*".
setOutOrderName
public void setOutOrderName(java.lang.String[] names)
- Specifies the names of the name-value pairs to be added to the
response object passed to the command's view task.
The values of the added name-value pairs are the ids
of the input orders. If no name is specified, it defaults to orderId.