com.ibm.commerce.orderitems.commands
Interface OrderItemDisplayCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
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:

View Task

If the addressId is set, it calls OrderItemDisplayViewShiptoDsp view task, otherwise it calls OrderItemDisplayViewShiptoAssoc view task.


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

setAddressId

public void setAddressId(java.lang.Long addressId)
Sets the id of the address book entry for the items to display (optional).
Parameters:
addressId - address id.

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

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.
Parameters:
names - an array of out order names.