com.ibm.commerce.orderitems.commands
Interface OrderItemAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
OrderItemAddCmdImpl, OrderItemBaseCmdImpl

public interface OrderItemAddCmd
extends ControllerCommand

Adds items to one or a list of orders.

This command accepts enumeration type of parameters. That is, it accepts parameterName_i=parameterValue.

For example, to add three order items with the catalog entries id 15, 16, and 17, you can pass catEntryId_1=15&catEntryId_2=16&catEntryId_3=17 to the command. If you call the individual set method setCatEntryId(Hashtable) to pass the above parameters, you need to create a hashtable and add the following to the hashtable:

      hashtable.put(new Integer(1), new String("15")); 
      hashtable.put(new Integer(2), new String("16")); 
      hashtable.put(new Integer(3), new String("17"));
Behavior View Exception conditions

Field Summary
static java.lang.String badPartNumberErrorView
          The parameter badPartNumberErrorView.
static java.lang.String badPartNumberList
          The parameter badPartNumberList.
static java.lang.String badPartNumberQuantityList
          The parameter badPartNumberQuantityList.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String goodPartNumberList
          The parameter goodPartNumberList.
static java.lang.String goodPartNumberQuantityList
          The parameter goodPartNumberQuantityList.
static java.lang.String multiplePartNumberCatalogEntriesList
          The parameter multiplePartNumberCatalogEntriesList.
static java.lang.String multiplePartNumberList
          The parameter multiplePartNumberList.
static java.lang.String multiplePartNumberQuantityList
          The parameter multiplePartNumberQuantityList.
static java.lang.String NAME
          The name of the Command Interface class.
 
Method Summary
 java.lang.String[] getOrderIds()
          Return a list of order ids which are touched or created by the command.
 java.lang.String[] getOrderItemIds()
          Return a list of order item ids which are created or updated by the command.
 void setAddressId(java.util.Hashtable ahshAddress_id)
          Set the address id parameters (optional).
 void setAttrName(java.util.Hashtable ahshAttr_name)
          Set the attribute name parameters (optional).
 void setAttrValue(java.util.Hashtable ahshAttr_value)
          Set the attribute value parameters (optional).
 void setCatEntryId(java.util.Hashtable ahshCatentry_id)
          Set the attribute name parameters.
 void setComment(java.util.Hashtable ahshComment)
          Set the comment parameters (optional).
 void setConfigurationId(java.util.Hashtable ahshConfigurationId)
          Set the configurationId parameters (optional).
 void setContinue(java.lang.String aContinue)
          Set the continue parameter (optional).
 void setContractId(java.util.Hashtable ahshContract_id)
          Set the contract id parameters (optional).
 void setCorrelationGroup(java.util.Hashtable ahshCorrelationGroup)
          Set the correlation group parameters.
 void setDescription(java.util.Hashtable ahshDescription)
          Set the description parameters (optional).
 void setExpandConfigurationId(java.util.Hashtable ahshExpandConfigurationId)
          Set the expandConfigurationId parameter.
 void setField1(java.util.Hashtable ahshField1)
          Set the field1 parameters (optional).
 void setField2(java.util.Hashtable ahshField2)
          Set the field2 parameters (optional).
 void setListId(java.lang.String[] aList_id)
          Set the interest item list id parameters (optional).
 void setMemberId(java.util.Hashtable ahshMember_id)
          Set the member id parameters (optional).
 void setOfferId(java.util.Hashtable ahshOffer_id)
          Set the offer id parameters (optional).
 void setOrderComment(java.lang.String aOrderComment)
          Set the Order comment parameter (optional).
 void setOrderDesc(java.lang.String aOrder_desc)
          Set the Order description parameter (optional).
 void setOrderId(java.lang.String[] aOrder_id)
          Set the order id parameters (optional).
 void setOutOrderItemName(java.lang.String[] aOut_orderitem_name)
          Set the out order item name parameters (optional).
 void setOutOrderName(java.lang.String[] aarrOutOrderName)
          Set the out order name parameters (optional).
 void setPartNumber(java.util.Hashtable ahshPart_number)
          Set the part number parameters (optional).
 void setQuantity(java.util.Hashtable ahshQuantity)
          Set the quantity parameters (mandatory).
 void setShipmodeId(java.util.Hashtable ahshShipmode_id)
          Set the ship mode id parameters (optional).
 void setTradingId(java.util.Hashtable ahshTrading_id)
          Set the trading id parameters (optional).
 void setUom(java.util.Hashtable ahshUom)
          Set the unit of measure parameters (optional).
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

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 the Command Interface class.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values

badPartNumberList

public static final java.lang.String badPartNumberList
The parameter badPartNumberList. If there are bad part numbers in the request, the following parameters will be in the response: badPartNumberList, goodPartNumberList, badPartNumberQuantityList, goodPartNumberQuantityList, badPartNumberErrorView.
See Also:
Constant Field Values

goodPartNumberList

public static final java.lang.String goodPartNumberList
The parameter goodPartNumberList.
See Also:
Constant Field Values

badPartNumberQuantityList

public static final java.lang.String badPartNumberQuantityList
The parameter badPartNumberQuantityList.
See Also:
Constant Field Values

goodPartNumberQuantityList

public static final java.lang.String goodPartNumberQuantityList
The parameter goodPartNumberQuantityList.
See Also:
Constant Field Values

multiplePartNumberList

public static final java.lang.String multiplePartNumberList
The parameter multiplePartNumberList. If there is a part number which can be resolved to multiple catalog entries, the following parameters will be in the response: multiplePartNumberList, multiplePartNumberQuantityList and multiplePartNumberCatalogEntriesList.
See Also:
Constant Field Values

multiplePartNumberQuantityList

public static final java.lang.String multiplePartNumberQuantityList
The parameter multiplePartNumberQuantityList.
See Also:
Constant Field Values

multiplePartNumberCatalogEntriesList

public static final java.lang.String multiplePartNumberCatalogEntriesList
The parameter multiplePartNumberCatalogEntriesList.
See Also:
Constant Field Values

badPartNumberErrorView

public static final java.lang.String badPartNumberErrorView
The parameter badPartNumberErrorView.
See Also:
Constant Field Values
Method Detail

getOrderIds

public java.lang.String[] getOrderIds()
Return a list of order ids which are touched or created by the command. These order ids are also appended to redirection url.
Returns:
an array of order IDs

getOrderItemIds

public java.lang.String[] getOrderItemIds()
Return a list of order item ids which are created or updated by the command. These order item ids are also appended to redirection url.
Returns:
an array of order item IDs

setAddressId

public void setAddressId(java.util.Hashtable ahshAddress_id)
Set the address id parameters (optional).
Parameters:
ahshAddress_id - Contains a list of address ids. The key is the enumeration group (Integer) and the value is the address id (String). For example, if you have input parameters: addressId_1=123&addressId=234, the hashtable can be constructed by:
    ahshAddress_id.put(new Integer(1), new String("123"));
    ahshAddress_id.put(new Integer(2), new String("234"));

setAttrName

public void setAttrName(java.util.Hashtable ahshAttr_name)
Set the attribute name parameters (optional). The attribute name, together with the attribute value are used to determine a SKU.
Parameters:
ahshAttr_name - Contains a list of attribute names. The key is the enumeration group (Integer) and the value is the attribute name (String[]). For example, if you have input parameters: attrName_1=123&attrName_1=234&attrName_2=123, the hashtable can be constructed by:
    ahshAttr_name.put(new Integer(1), new String[] {"123", "234"});
    ahshAttr_name.put(new Integer(2), new String[] {"123"});

setAttrValue

public void setAttrValue(java.util.Hashtable ahshAttr_value)
Set the attribute value parameters (optional). The attribute name, together with the attribute value are used to determine a SKU.
Parameters:
ahshAttr_value - a list of attribute values.

setCatEntryId

public void setCatEntryId(java.util.Hashtable ahshCatentry_id)
Set the attribute name parameters. This parameter is mandatory if the partNumber parameter is not set. This parameter is ignored when the partNumber parameter is set.
Parameters:
ahshCatentry_id - a list of catalog entry ids.

setComment

public void setComment(java.util.Hashtable ahshComment)
Set the comment parameters (optional).
Parameters:
ahshComment - a list of comments

setConfigurationId

public void setConfigurationId(java.util.Hashtable ahshConfigurationId)
Set the configurationId parameters (optional).
Parameters:
ahshConfigurationId - a list of configuration ids.

setContinue

public void setContinue(java.lang.String aContinue)
Set the continue parameter (optional).
Parameters:
aContinue - a string can be either "0" or "1".

setContractId

public void setContractId(java.util.Hashtable ahshContract_id)
Set the contract id parameters (optional). It is used to calculate the price.
Parameters:
ahshContract_id - a list of contract ids.

setCorrelationGroup

public void setCorrelationGroup(java.util.Hashtable ahshCorrelationGroup)
Set the correlation group parameters. It is optional.
Parameters:
ahshCorrelationGroup - a list of correlation groups.

setDescription

public void setDescription(java.util.Hashtable ahshDescription)
Set the description parameters (optional).
Parameters:
ahshDescription - a list of order item descriptions.

setExpandConfigurationId

public void setExpandConfigurationId(java.util.Hashtable ahshExpandConfigurationId)
Set the expandConfigurationId parameter. This parameter is optional.
Parameters:
ahshExpandConfigurationId - a list of expand configuration ids.

setField1

public void setField1(java.util.Hashtable ahshField1)
Set the field1 parameters (optional).
Parameters:
ahshField1 - a list of field1.

setField2

public void setField2(java.util.Hashtable ahshField2)
Set the field2 parameters (optional).

setListId

public void setListId(java.lang.String[] aList_id)
Set the interest item list id parameters (optional).
Parameters:
aList_id - an array of interest item list ids.

setMemberId

public void setMemberId(java.util.Hashtable ahshMember_id)
Set the member id parameters (optional). It is the catalog owner's member id. It is necessary when the partNumber parameter is set. Together with the partNumber, the catalog entry id can uniquely be determined.
Parameters:
ahshMember_id - a list of member ids.

setOfferId

public void setOfferId(java.util.Hashtable ahshOffer_id)
Set the offer id parameters (optional). It is used to calculate the price.
Parameters:
ahshOffer_id - a list of offer ids.

setOrderComment

public void setOrderComment(java.lang.String aOrderComment)
Set the Order comment parameter (optional).
Parameters:
aOrderComment - order comment.

setOrderDesc

public void setOrderDesc(java.lang.String aOrder_desc)
Set the Order description parameter (optional).
Parameters:
aOrder_desc - order description.

setOrderId

public void setOrderId(java.lang.String[] aOrder_id)
Set the order id parameters (optional). If it is not set, the current pending order id will be used. If there is no current pending order, a new order will be created.
Parameters:
aOrder_id - an array of order ids.

setOutOrderItemName

public void setOutOrderItemName(java.lang.String[] aOut_orderitem_name)
Set the out order item name parameters (optional). If it is not set, the default name is "orderItemId".
Parameters:
aOut_orderitem_name - an array of out order item names.

setOutOrderName

public void setOutOrderName(java.lang.String[] aarrOutOrderName)
Set the out order name parameters (optional). If it is not set, the default name is "orderId".
Parameters:
aarrOutOrderName - an array of out order names.

setPartNumber

public void setPartNumber(java.util.Hashtable ahshPart_number)
Set the part number parameters (optional).
Parameters:
ahshPart_number - a list of part numbers.

setQuantity

public void setQuantity(java.util.Hashtable ahshQuantity)
Set the quantity parameters (mandatory).
Parameters:
ahshQuantity - a list of quantities.

setShipmodeId

public void setShipmodeId(java.util.Hashtable ahshShipmode_id)
Set the ship mode id parameters (optional).
Parameters:
ahshShipmode_id - a list of shipping mode ids.

setTradingId

public void setTradingId(java.util.Hashtable ahshTrading_id)
Set the trading id parameters (optional). It is used to calculate the price.
Parameters:
ahshTrading_id - a list of trading ids.

setUom

public void setUom(java.util.Hashtable ahshUom)
Set the unit of measure parameters (optional).
Parameters:
ahshUom - a list of UOMs.