com.ibm.commerce.interestitems.commands
Interface InterestItemAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
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 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:

then passed the hashtable to the method setCatEntryId(Hashtable).

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.interestitems.commands.InterestItemAddCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.interestitems.commands.InterestItemAddCmd".
 
Method Summary
 void setAttrName(java.util.Hashtable ahshAttrName)
          Sets the attribute name parameters (optional).
 void setAttrValue(java.util.Hashtable ahshAttrValue)
          Sets the attribute value parameters (optional).
 void setCatEntryId(java.util.Hashtable ahshCatEntryId)
          Sets the catentry ID parameters.
 void setField1(java.util.Hashtable ahshField1)
          Sets the field1 parameters (optional).
 void setField2(java.util.Hashtable ahshField2)
          Sets the field2 parameters (optional).
 void setField3(java.util.Hashtable ahshField3)
          Sets the field3 parameters (optional).
 void setListId(java.lang.String[] asaListId)
          Sets the interest item list ID parameters (optional with default ".").
 void setListIdName(java.lang.String[] asaListIdName)
          Sets the names of the name-value pairs to be added to the redirection URL (optional).
 void setMemberId(java.util.Hashtable ahshMemberId)
          Sets the member ID parameters.
 void setPartNumber(java.util.Hashtable ahshPartNumber)
          Sets the part number parameters.
 void setQuantity(java.util.Hashtable ahshQuantity)
          Sets the quantity parameters (optional with default is 1).
 void setUOM(java.util.Hashtable ahshUOM)
          Set the unit of measure parameters (optional).
 void setUpdateable(java.util.Hashtable ahshUpdatable)
          Set the updatable 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
The internal copyright field.
See Also:
Constant Field Values

NAME

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

defaultCommandClassName

public 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

public 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

public 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

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

setField1

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

setField2

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

setField3

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

setListId

public void setListId(java.lang.String[] asaListId)
Sets the interest item list ID parameters (optional with default ".").
Parameters:
asaListId - the interest item list IDs

setListIdName

public 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

public 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

public 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

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

setUOM

public 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

public void setUpdateable(java.util.Hashtable ahshUpdatable)
Set the updatable parameters (optional). Specify what to do when the command requests that an catalog entry should be added to a list and it is already on that list:
Parameters:
ahshUpdatable - a hash table of updateable flags