com.ibm.commerce.orderitems.commands

Interface OrderItemDisplayCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

OrderItemDisplayCmdImpl

public interface OrderItemDisplayCmd
extends ControllerCommand

This Order controller command is used to display a list of order items with pending order status. The default implementation of this command is OrderItemDisplayCmdImpl.

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.

Field Summary

Fields

Modifier and Type	Field and Description
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.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setAddressId(java.lang.Long addressId) This method sets the id of the address book entry for the items to display (optional).
void	setOrderId(java.lang.String[] orderId) This method sets zero or more order ids (optional).
void	setOutOrderName(java.lang.String[] names) This method sets 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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the Command Interface class.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class.

See Also:

Constant Field Values

Method Detail

setAddressId

void setAddressId(java.lang.Long addressId)

This method sets the id of the address book entry for the items to display (optional).

Parameters:

addressId - address id.

setOrderId

void setOrderId(java.lang.String[] orderId)

This method sets 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

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

This method sets 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.