com.ibm.commerce.interestitems.commands

Interface InterestItemAddCmd

  • 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:
    InterestItemAddCmdImpl


    public interface InterestItemAddCmd
    extends ControllerCommand
    The InterestItemAddCmd is a controller command that adds items or products to interest item lists. The interest items are stored in the IITEM table.
    This command accepts enumeration type of parameters. That is, it accepts parameterName_i=parameterValue.
    For example, to add three catalog entries with ID 15, 16, and 17 to a certain interest item list, you can pass catEntryId_1=15&catEntryId_2=16&catEntryId_3=17 to the command. If you call the individual set method 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"));
    then passed the hashtable to the method setCatEntryId(Hashtable).
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.interestitems.commands.InterestItemAddCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.interestitems.commands.InterestItemAddCmdImpl".
        See Also:
        Constant Field Values
    • Method Detail

      • setAttrName

        void setAttrName(java.util.Hashtable ahshAttrName)
        Sets the attribute name parameters (optional). The attribute name, together with the attribute value are used to determine an item.
        Parameters:
        ahshAttrName - the hash table of attribute names
      • setAttrValue

        void setAttrValue(java.util.Hashtable ahshAttrValue)
        Sets the attribute value parameters (optional). The attribute name, together with the attribute value are used to determine an item.
        Parameters:
        ahshAttrValue - the hash table of attribute values
      • setCatEntryId

        void setCatEntryId(java.util.Hashtable ahshCatEntryId)
        Sets the catentry ID parameters.
        Parameters:
        ahshCatEntryId - the hash table of catalog entry IDs
      • setField1

        void setField1(java.util.Hashtable ahshField1)
        Sets the field1 parameters (optional).
        Parameters:
        ahshField1 - the hash table of custom fields
      • setField2

        void setField2(java.util.Hashtable ahshField2)
        Sets the field2 parameters (optional).
        Parameters:
        ahshField2 - the hash table of custom fields
      • setField3

        void setField3(java.util.Hashtable ahshField3)
        Sets the field3 parameters (optional).
        Parameters:
        ahshField3 - the hash table of custom fields
      • setListId

        void setListId(java.lang.String[] asaListId)
        Specifies zero or more interest item lists from which to be added. In addition to interest item list reference numbers it can be specified as one of the special abbreviations ".", "*". If "." is specified, the GetCurrentIILists process task is invoked to obtain the shopper's current interest item lists. Then the command behaves as if the current interest item lists were specified. If GetCurrentIILists process task determines that there are no current interest item lists; the most recently updated item interest item list is used. If there is no interest item list at all, a new interest item list will be created. If "*" is specified, the command behaves as if all shopper's interest item lists are specified. If a specified interest item list no longer exists, it is not added. If this parameter is missing, this command behaves as if "." was specified.
        Parameters:
        asaListId - the interest item list IDs
      • setListIdName

        void setListIdName(java.lang.String[] asaListIdName)
        Sets the names of the name-value pairs to be added to the redirection URL (optional). The values of the added name-value pairs are the reference number of the interest item lists specified by listId. This is provided to make it possible to obtain the reference numbers of the interest item lists when listId is not explicitly specified.
        Parameters:
        asaListIdName - the interest item list ID names
      • setMemberId

        void setMemberId(java.util.Hashtable ahshMemberId)
        Sets the member ID parameters. MemberId + PartNumber can be supplied in place of a CatentryId.
        Parameters:
        ahshMemberId - a hash table of member IDs
      • setPartNumber

        void setPartNumber(java.util.Hashtable ahshPartNumber)
        Sets the part number parameters. MemberId + PartNumber can be supplied in place of a CatentryId.
        Parameters:
        ahshPartNumber - a hash table of part numbers
      • setQuantity

        void setQuantity(java.util.Hashtable ahshQuantity)
        Sets the quantity parameters (optional with default is 1).
        Parameters:
        ahshQuantity - a hash table of quantities
      • setUOM

        void setUOM(java.util.Hashtable ahshUOM)
        Set the unit of measure parameters (optional). Used with quantity to calculate the normalized quantity
        Parameters:
        ahshUOM - a hash table of units
      • setUpdateable

        void setUpdateable(java.util.Hashtable ahshUpdatable)
        Set the updatable parameters (optional). Specify what to do when the command requests that a catalog entry should be added to a list and it is already on that list:
        • 1=Update it,
        • 0=Throw an exception,
        • Not specified=Defaults to 1.
        Parameters:
        ahshUpdatable - a hash table of updateable flags