com.ibm.commerce.orderitems.commands
Class AddItemsToFulfillmentOrderCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.orderitems.commands.AddItemsToFulfillmentOrderCmdImpl
All Implemented Interfaces:
AddItemsToFulfillmentOrderCmd, ECCommand, ECTargetableCommand, TaskCommand

public class AddItemsToFulfillmentOrderCmdImpl
extends TaskCommandImpl
implements AddItemsToFulfillmentOrderCmd

This AddItemsToFulfillmentOrderCmd Task Command Implementation is called by the AssignToSpecifiedFulfillmentCenterCmd Controller Command to add items to a fulfillment order at the fulfillment center store.

The command could be used to add items to an existing fulfillment order if a fulfillment order ID is specified. If no fulfillment order ID is specified, a new fulfillment order is created. This command implementation class calls the OrderItemAddCmd Controller Command to add the items identified by the Catalog Entry ID to a pending order in the specified Store.

This command implementation of the AddItemsToFulfillmentOrderCmd Task Command ignores the ItemSpec ID parameters and ItemSpecQuantity parameters.

This command calls the following TaskCommands:

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.orderitems.commands. AddItemsToFulfillmentOrderCmd
COPYRIGHT, defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
AddItemsToFulfillmentOrderCmdImpl()
          AddItemsToFulfillmentOrderCmdImpl constructor comment.
 
Method Summary
protected  java.lang.String getFulfillmentOrderId()
          Returns the fulfillmentOrderId parameter specified by the caller.
protected  java.lang.String getFulfillmentOrderName()
          Returns the fulfillmentOrderName parameter specified by the caller.
 java.lang.String getOrderReferenceNumber()
          Returns the order reference number of the fulfillment order.
 void performExecute()
          Performs the main business logic of the command.
 void reset()
          Resets the instance variables of the command.
 void setCatalogEntryId(java.util.Hashtable ahshCatEntryId)
          Sets the Catalog Entry ID parameters.
 void setFulfillmentOrderId(java.lang.String strOrderId)
          Sets the fulfillmentOrderId property of the command.
 void setFulfillmentOrderName(java.lang.String strOrderName)
          Sets the fulfillmentOrderName property of the command.
 void setItemSpecId(java.util.Hashtable ahshItemSpecId)
          Sets the specified item ID parameters.
 void setItemSpecQuantity(java.util.Hashtable ahshQuantity)
          Sets the specified item quantity parameters.
protected  void setOrderReferenceNumber(java.lang.String strOrderRefNum)
          Sets the order reference number returned from the execution of this command.
 void setQuantity(java.util.Hashtable ahshQuantity)
          Sets the quantity parameters.
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddItemsToFulfillmentOrderCmdImpl

public AddItemsToFulfillmentOrderCmdImpl()
AddItemsToFulfillmentOrderCmdImpl constructor comment.
Method Detail

getFulfillmentOrderId

protected java.lang.String getFulfillmentOrderId()
Returns the fulfillmentOrderId parameter specified by the caller.
Returns:
The fulfillment order ID.

getFulfillmentOrderName

protected java.lang.String getFulfillmentOrderName()
Returns the fulfillmentOrderName parameter specified by the caller.
Returns:
The fulfillment order name.

getOrderReferenceNumber

public java.lang.String getOrderReferenceNumber()
Returns the order reference number of the fulfillment order.

For this implementation, the oredr reference number returned is the ID of the fulfillment order.

Specified by:
getOrderReferenceNumber in interface AddItemsToFulfillmentOrderCmd
Returns:
The order reference number.

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.

This command implementation does not make use of the ItemSpec ID parameters set by the Caller.

Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException.
ECException

reset

public void reset()
Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters, then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

This is useful if the command instance is to be called multiple times with different command parameters.

Overrides:
reset in class AbstractECTargetableCommand

setCatalogEntryId

public void setCatalogEntryId(java.util.Hashtable ahshCatEntryId)
Sets the Catalog Entry ID parameters.

Specifies the IDs of the catalog entries to be added to the fulfillment order.

This is a mandatory parameter.

Specified by:
setCatalogEntryId in interface AddItemsToFulfillmentOrderCmd
Parameters:
ahshCatEntryId - The Hashtable containing the string representation of the IDs of the Catalog Entries that are to be added to the fulfillment order. Each Catalog Entry ID is keyed by an Integer index starting with the Integer with int value of 1.

setFulfillmentOrderId

public void setFulfillmentOrderId(java.lang.String strOrderId)
Sets the fulfillmentOrderId property of the command.

This parameter is required if we are adding to an existing fulfillment order.

Specified by:
setFulfillmentOrderId in interface AddItemsToFulfillmentOrderCmd
Parameters:
strOrderId - The ID of the fulfillment order that is to be the target for this add operation.

setFulfillmentOrderName

public void setFulfillmentOrderName(java.lang.String strOrderName)
Sets the fulfillmentOrderName property of the command.

This parameter is ignored if we are adding to an existing order.

Specified by:
setFulfillmentOrderName in interface AddItemsToFulfillmentOrderCmd
Parameters:
strOrderName - The name to be used for the fulfillment order if a new one is to be created by this add operation.

setItemSpecId

public void setItemSpecId(java.util.Hashtable ahshItemSpecId)
Sets the specified item ID parameters.

Specifies the IDs of the specified items that are to be added to the fulfillment order.

For this command implementation, this parameter is ignored.

Specified by:
setItemSpecId in interface AddItemsToFulfillmentOrderCmd
Parameters:
ahshItemSpecId - The Hashtable containing the string representation of the IDs of the specified items that are to be added to the fulfillment order. Each ItemSpec ID is keyed by an Integer index starting with the Integer with int value of 1.

setItemSpecQuantity

public void setItemSpecQuantity(java.util.Hashtable ahshQuantity)
Sets the specified item quantity parameters.

Specifies the quantities of the specified items we want to add to the fulfillment order.

For this command implementation, this parameter is ignored.

Specified by:
setItemSpecQuantity in interface AddItemsToFulfillmentOrderCmd
Parameters:
ahshQuantity - The Hashtable containing the string representation of the quantities of specified items that are to be added to the fulfillment order. Each quantity value is keyed by an Integer index starting with the Integer with int value of 1.

setOrderReferenceNumber

protected void setOrderReferenceNumber(java.lang.String strOrderRefNum)
Sets the order reference number returned from the execution of this command.

For this implementation, this is the ID of the fulfillment order.

Parameters:
strOrderRefNum - The order reference number.

setQuantity

public void setQuantity(java.util.Hashtable ahshQuantity)
Sets the quantity parameters.

Specifies the quantities of the Catalog Entry items we want to add to the fulfillment order.

This is a mandatory parameter.

Specified by:
setQuantity in interface AddItemsToFulfillmentOrderCmd
Parameters:
ahshQuantity - The Hashtable containing the string representation of the quantities of items that are to be added to the fulfillment order. Each quantity value is keyed by an Integer index starting with the Integer with int value of 1.