com.ibm.commerce.quote.commands

Interface QuoteItemAddCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    AdminQuoteItemUpdateCmdImpl, QuoteItemAddCmdImpl, QuoteItemUpdateCmdImpl

    public interface QuoteItemAddCmd
extends ControllerCommand
    This Order controller command is used to add an item to a quote. This is similar in functionality to the OrderItemAddCmd. However, the inventory and a fulfillment center are not allocated for the item. It is mandatory to provide the orderId for the quote that the item is being added to. The quote must be in MAJORSTATUS = NEW state for this command to function.

    Parameters (A sample listing is provided here. For details, refer to the OrderItemUpdateCmd command.)

    orderId (mandatory)
    The Id of the quote. This must be a number.
    catEntryId (optional)
    The Id of the QuoteItem. This must be a number.
    URL (mandatory)
    The URL to be called when the command completes successfully.
    The default implementation of this command is QuoteItemAddCmdImpl. The QuoteItemAdd<> URL is mapped to this command by default.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        The name of this command.

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values

    • Method Detail

      • getOrderIds

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

      • getOrderItemIds

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

      • setAddressId

        void setAddressId(java.util.Hashtable ahshAddress_id)
        Sets 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

        void setAttrName(java.util.Hashtable ahshAttr_name)
        Sets 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

        void setAttrValue(java.util.Hashtable ahshAttr_value)
        Sets 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

        void setCatEntryId(java.util.Hashtable ahshCatentry_id)
        Sets 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

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

      • setConfigurationId

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

      • setContinue

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

      • setContractId

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

      • setCorrelationGroup

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

      • setDescription

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

      • setExpandConfigurationId

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

      • setField1

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

      • setField2

        void setField2(java.util.Hashtable ahshField2)
        Sets the field2 parameters (optional).
        Parameters:
        ahshField2 - a list of field2.

      • setListId

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

      • setMemberId

        void setMemberId(java.util.Hashtable ahshMember_id)
        Sets 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

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

      • setOrderComment

        void setOrderComment(java.lang.String aOrderComment)
        Sets the comment for the quote (optional).
        Parameters:
        aOrderComment -

      • setOrderDesc

        void setOrderDesc(java.lang.String aOrder_desc)
        Sets the description for the quote (optional).
        Parameters:
        aOrder_desc -

      • setOrderId

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

      • setOutOrderItemName

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

      • setPartNumber

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

      • setQuantity

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

      • setShipmodeId

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

      • setTradingId

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

      • setUom

        void setUom(java.util.Hashtable ahshUom)
        Sets the unit of measure parameters (optional).
        Parameters:
        ahshUom - a list of UOMs.
Skip navigation links