com.ibm.commerce.orderitems.commands
Class OrderItemDisplayCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.orderitems.commands.OrderItemDisplayCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderItemDisplayCmd

public class OrderItemDisplayCmdImpl
extends ControllerCommandImpl
implements OrderItemDisplayCmd

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:
See Also:
Serialized Form

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
IBM copyright notice field.
See Also:
Constant Field Values
Constructor Detail

OrderItemDisplayCmdImpl

public OrderItemDisplayCmdImpl()
Method Detail

getAddressId

protected java.lang.Long getAddressId()
Gets the input parameter addressId.
Returns:
address id.

getATPParms

public ATPParameters getATPParms()
Gets the input ATP parameters.
Returns:
ATPParameters.

getOrderIds

protected java.lang.String[] getOrderIds()
Return a list of ids of the orders which are displayed. These order ids are also appended to redirection url.
Returns:
an array of order ids.

getResources

public AccessVector getResources()
                          throws ECException
Gets the resources.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
resource access vector.
Throws:
ECException

performExecute

public void performExecute()
                    throws ECException
The main entry point of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException

reset

public void reset()
Reset all instance variables.
Overrides:
reset in class AbstractECTargetableCommand

setAddressId

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

setATPParms

public void setATPParms(ATPParameters newATPParms)
Set the ATP parameters.
Parameters:
newATPParms - ATPParameters

setOrderId

public void setOrderId(java.lang.String[] numbers)
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 "*".
Specified by:
setOrderId in interface OrderItemDisplayCmd
Parameters:
numbers - 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.
Specified by:
setOutOrderName in interface OrderItemDisplayCmd
Parameters:
names - an array of out order names.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
aRequestProperties - request properties.
Throws:
ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException
Verify the input parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException