com.ibm.commerce.interestitems.commands
Interface InterestItemAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
InterestItemAddCmdImpl

public interface InterestItemAddCmd
extends ControllerCommand

Adds items or products to interest item lists. 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: 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 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)
          Set the attribute name parameters (optional).
 void setAttrValue(java.util.Hashtable ahshAttrValue)
          Set the attribute value parameters (optional).
 void setCatEntryId(java.util.Hashtable ahshCatEntryId)
          Set the catentry id parameters.
 void setField1(java.util.Hashtable ahshField1)
          Set the field1 parameters (optional).
 void setField2(java.util.Hashtable ahshField2)
          Set the field2 parameters (optional).
 void setField3(java.util.Hashtable ahshField3)
          Set the field3 parameters (optional).
 void setListId(java.lang.String[] asaListId)
          Set the interest item list id parameters (optional with default ".").
 void setListIdName(java.lang.String[] asaListIdName)
          Set the names of the name-value pairs to be added to the redirection URL (optional).
 void setMemberId(java.util.Hashtable ahshMemberId)
          Set the member id parameters.
 void setPartNumber(java.util.Hashtable ahshPartNumber)
          Set the part number parameters.
 void setQuantity(java.util.Hashtable ahshQuantity)
          Set 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
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.interestitems.commands.InterestItemAddCmdImpl".

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.interestitems.commands.InterestItemAddCmd".
Method Detail

setAttrName

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

setAttrValue

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

setCatEntryId

public void setCatEntryId(java.util.Hashtable ahshCatEntryId)
Set the catentry id parameters.
Parameters:
ahshCatEntryId - java.util.Hashtable

setField1

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

setField2

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

setField3

public void setField3(java.util.Hashtable ahshField3)
Set the field3 parameters (optional).
Parameters:
ahshField3 - java.util.Hashtable

setListId

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

setListIdName

public void setListIdName(java.lang.String[] asaListIdName)
Set 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 - java.lang.String[]

setMemberId

public void setMemberId(java.util.Hashtable ahshMemberId)
Set the member id parameters. MemberId + PartNumber can be supplied in place of a CatentryId
Parameters:
ahshMemberId - java.util.Hashtable

setPartNumber

public void setPartNumber(java.util.Hashtable ahshPartNumber)
Set the part number parameters. MemberId + PartNumber can be supplied in place of a CatentryId
Parameters:
ahshPartNumber - java.util.Hashtable

setQuantity

public void setQuantity(java.util.Hashtable ahshQuantity)
Set the quantity parameters (optional with default is 1).
Parameters:
ahshQuantity - java.util.Hashtable

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 - java.util.Hashtable

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: 1=Update it 0=Throw an exception Not specified=Defaults to 1
Parameters:
ahshUpdatable - java.util.Hashtable