java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.orderitems.commands.OrderItemDisplayCmdImpl
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. This command calls the following TaskCommands:
This command uses the following AccessBeans:
OrderAccessBean
OrderItemAccessBean
CatalogEntryAccessBean
CatalogEntryShippingAccessBean
AddressAccessBean
UserRegistryAccessBean
StoreAccessBean
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.orderitems.commands. OrderItemDisplayCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
OrderItemDisplayCmdImpl() |
Method Summary | |
---|---|
protected
java.lang.Long |
getAddressId() Gets the input parameter addressId. |
ATPParameters |
getATPParms() Gets the input ATP parameters. |
protected
java.lang.String[] |
getOrderIds() Return a list of ids of the orders which are displayed. |
AccessVector |
getResources() Gets the resources. |
void |
performExecute() The main entry point of the command. |
void |
reset() Reset all instance variables. |
void |
setAddressId(java.lang.Long addressId) Sets the id of the address book entry for the items to display (optional). |
void |
setATPParms(
ATPParameters newATPParms) Set the ATP parameters. |
void |
setOrderId(java.lang.String[] numbers) 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. |
void |
setRequestProperties(
TypedProperty aRequestProperties) Sets the request properties. |
void |
validateParameters() Verify the input parameters. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
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,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public OrderItemDisplayCmdImpl()
Method Detail |
---|
protected java.lang.Long getAddressId()
public ATPParameters getATPParms()
protected java.lang.String[] getOrderIds()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
reset
in class
AbstractECTargetableCommand
public void setAddressId(java.lang.Long addressId)
setAddressId
in interface
OrderItemDisplayCmd
addressId
- address id.public void setATPParms(ATPParameters newATPParms)
newATPParms
- ATPParameterspublic void setOrderId(java.lang.String[] numbers)
setOrderId
in interface
OrderItemDisplayCmd
numbers
- an array of order ids.public void setOutOrderName(java.lang.String[] names)
setOutOrderName
in interface
OrderItemDisplayCmd
names
- an array of out order names.public void setRequestProperties(TypedProperty aRequestProperties) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
aRequestProperties
- request properties.
ECApplicationException
public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException