com.ibm.commerce.order.commands
Interface ExtOrderCopyCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ExtOrderCopyCmdImpl

public interface ExtOrderCopyCmd
extends TaskCommand

Perform custom processing just prior to the completion of the OrderCopyCmd controller command. This task command may be overridden to perform custom processing associated with the execution of the OrderCopyCmd controller command. It is called by the default implementation of the OrderCopyCmd controller command just before it completes execution.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
static java.lang.String defaultCommandClassName
          The name of the default implementation class for this command interface.
static java.lang.String NAME
          The name of this command interface.
 
Method Summary
 void setCopiedOrderItems(java.util.HashMap ahshCopiedOrderItems)
          Sets the copied OrderItems.
 void setDeletedOrderItemIds(java.util.Set asetDeletedOrderItemIds)
          Sets the identfiers of deleted OrderItems.
 void setNewOrderItems(java.util.HashMap ahshNewOrderItems)
          Sets the new OrderItems.
 void setOrderInfoFrom( OrderAccessBean aabOrderInfoFrom)
          Sets the Order from which the Order level info is copied.
 void setPayInfoFrom( OrderAccessBean aabPayInfoFrom)
          Sets the Order from which the payment information is copied.
 void setRequestProperties( TypedProperty aRequestProperties)
          Sets the requestProperties object for this command.
 void setResponseProperties( TypedProperty aResponseProperties)
          Sets the responseProperties object that the calling command has produced.
 void setToOrder( OrderAccessBean aabToOrder)
          Sets the target order.
 void setUpdatedOrderItems(java.util.HashMap ahshUpdatedOrderItems)           Sets the updated OrderItems.
 

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 this command interface.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The name of the default implementation class for this command interface.
See Also:
Constant Field Values
Method Detail

setOrderInfoFrom

public void setOrderInfoFrom(OrderAccessBean aabOrderInfoFrom)
Sets the Order from which the Order level info is copied.
Parameters:
aabOrderInfoFrom - the Order from which the Order level information is copied.

setPayInfoFrom

public void setPayInfoFrom(OrderAccessBean aabPayInfoFrom)
Sets the Order from which the payment information is copied.
Parameters:
aabPayInfoFrom - the Order from which the payment information is copied.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets the requestProperties object for this command.
Parameters:
aRequestProperties - the request properties.
ECApplicationException

setResponseProperties

public void setResponseProperties(TypedProperty aResponseProperties)
Sets the responseProperties object that the calling command has produced.
Parameters:
aResponseProperties - the responseProperties object that the calling command has produced.

setToOrder

public void setToOrder(OrderAccessBean aabToOrder)
Sets the target order.
Parameters:
aabToOrder - the Order that has been created or updated by the calling command.

setNewOrderItems

public void setNewOrderItems(java.util.HashMap ahshNewOrderItems)
Sets the new OrderItems. The key (i.e. enumeration group) can be used to correlate a new OrderItem with a source (i.e. copied) OrderItem. A new OrderItem may be created from input parameters only (that is, not copied from a source OrderItem). In such cases, the new OrderItem's enumeration group will not be found in the copiedOrderItems HashMap.
Parameters:
ahshNewOrderItems - the new OrderItems.
  • Key: enumeration group (Integer).
  • Value: new OrderItem (OrderItemAccessBean).

setCopiedOrderItems

public void setCopiedOrderItems(java.util.HashMap ahshCopiedOrderItems)
Sets the copied OrderItems. The key (i.e. enumeration group) can be used to correlate a new OrderItem with a source (i.e. copied) OrderItem. A new OrderItem may be created from input parameters only (that is, not copied from a source OrderItem). In such cases, the new OrderItem's enumeration group will not be found in the copiedOrderItems HashMap. The OrderItemAccessBeans may reference OrderItems that have since been deleted. Use the Set provided by setDeletedOrderItemIds(Set) to determine if an OrderItemAccessBean has been deleted. The OrderItemAccessBeans contain information obtained from the database before any modifications were made. Use OrderItemAccessBean.refreshCopyHelper() to obtain the updated OrderItemAccessBean information.
Parameters:
ahshCopiedOrderItems - the copied OrderItems.
  • Key: enumeration group (Integer).
  • Value: copied OrderItem (OrderItemAccessBean).

setUpdatedOrderItems

public void setUpdatedOrderItems(java.util.HashMap ahshUpdatedOrderItems)
Sets the updated OrderItems. The OrderItemAccessBeans may reference OrderItems that have since been deleted. Use the Set provided by setDeletedOrderItemIds(Set) to determine if an OrderItemAccessBean has been deleted. The OrderItemAccessBeans contain information obtained from the database before any modifications were made. Use OrderItemAccessBean.refreshCopyHelper() to obtain the updated OrderItemAccessBean information.
Parameters:
ahshUpdatedOrderItems - the updated OrderItems.
  • Key: enumeration group (Integer).
  • Value: updated OrderItem (OrderItemAccessBean).

setDeletedOrderItemIds

public void setDeletedOrderItemIds(java.util.Set asetDeletedOrderItemIds)
Sets the identfiers of deleted OrderItems.
Parameters:
asetDeletedOrderItemIds - the elements are the (String) identifiers of the deleted OrderItems.