com.ibm.commerce.orderitems.commands

Class OrderItemDisplayCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.orderitems.commands.OrderItemDisplayCmdImpl

All Implemented Interfaces:

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

public class OrderItemDisplayCmdImpl
extends ControllerCommandImpl
implements OrderItemDisplayCmd

This is the default implementation of the OrderItemDisplayCmd controller command used to Display a list of order items with pending order status.

Input parameters:

Name	Description
addressId	The address Id. Optional
orderId	The order Id abbreviations. Optional
outOrderName	Names of the name-value pairs for Order Id to be added to the response object. Optional

Output parameters:

Name	Description
addressId	If addressId is passed in, the usable address related to it will be put in.
The value for outOrderName[i]	The array of order Ids.
errorOrderItemId	The array of orderItem Id there are not enough inventory when checking inventory.

Behaviour:

• 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.
  • Update the price for the orderItems
  • Check inventory for the orderItems
• View Task
  • If the addressId is set, it calls OrderItemDisplayViewShiptoDsp view task
  • otherwise it calls OrderItemDisplayViewShiptoAssoc view task.

This command calls the following TaskCommands:

• CheckInventoryCmd
• DoInventoryActionCmd
• UpdateShippingAddressCmd
• GetBaseUnitPriceCmd
• GetContractUnitPriceCmd

This command uses the following AccessBeans:

• OrderAccessBean
• OrderItemAccessBean
• CatalogEntryAccessBean
• CatalogEntryShippingAccessBean
• AddressAccessBean
• UserRegistryAccessBean
• StoreAccessBean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.orderitems.commands.OrderItemDisplayCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OrderItemDisplayCmdImpl() Default constructor

Method Summary

Modifier and Type	Method and Description
ATPParameters	getATPParms() This method gets the input ATP parameters.
AccessVector	getResources() This method gets the resources.
void	performExecute() The main entry point of the command.
void	reset() This method resets all instance variables.
void	setAddressId(java.lang.Long addressId) This method sets the id of the address book entry for the items to display (optional).
void	setATPParms(ATPParameters newATPParms) This method sets the ATP parameters.
void	setOrderId(java.lang.String[] numbers) 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.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the request properties.
void	validateParameters() This method verifies 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, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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.websphere.command.CacheableCommand

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

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

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

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

isReadyToCallExecute

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

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

OrderItemDisplayCmdImpl

public OrderItemDisplayCmdImpl()

Default constructor

Method Detail

getATPParms

public ATPParameters getATPParms()

This method gets the input ATP parameters.

Returns:

ATPParameters.

getResources

public AccessVector getResources()
                          throws ECException

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

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

This method resets all instance variables.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setAddressId

public void setAddressId(java.lang.Long addressId)

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

This method sets the ATP parameters.

Parameters:

newATPParms - ATPParameters

setOrderId

public void setOrderId(java.lang.String[] numbers)

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 "*".

Specified by:

setOrderId in interface OrderItemDisplayCmd

Parameters:

numbers - an array of order ids.

setOutOrderName

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

Specified by:

setOutOrderName in interface OrderItemDisplayCmd

Parameters:

names - an array of out order names.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException

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

This method verifies the input parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException