com.ibm.commerce.productset.commands
Interface ProductSetAddCmd

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

public interface ProductSetAddCmd
extends ControllerCommand

Add a product set definition based on the input XML input.

Input parameters:
NameTypeRequirementDescription
productSetXmlStringmandatoryThe XML string of the product set definition.
productSetDescriptionStringoptionalThe description of the product set.
languageIdIntegeroptionalThe language of the description.

Output parameters:
NameTypeDescription
productSetIdIntegerThe newly created product set's ID.
productSetNameStringThe newly created product set's name.
memberIdLongThe newly created product set's member ID.

Behavior:

Exception:


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The fully qualified name of the default implementation class.
static java.lang.String NAME
          The fully qualified name of this class.
 
Method Summary
 java.lang.Long getMemberId()
          Returns the MemberId that represents the primary key of the owner of the product set.
 java.lang.Integer getProductSetId()
          Returns the ProductSetId that represents the primary key of the product set.
 java.lang.String getProductSetName()
          Returns the Name of the product set.
 void setLanguageId(java.lang.Integer newLanguageId)
          Sets the LanguageId that represents the primary key of language of the product set description.
 void setProductSetDescription(java.lang.String newProductSetDescription)
          Sets the product set description.
 void setProductSetXml(java.lang.String newProductSetXml)
          Sets the XML definition of the product set.
 void setStatic(java.lang.String newStatic)
          Sets the static value of the product set.
 
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 fully qualified name of the default implementation class.

NAME

public static final java.lang.String NAME
The fully qualified name of this class.
Method Detail

getMemberId

public java.lang.Long getMemberId()
Returns the MemberId that represents the primary key of the owner of the product set.
Returns:
java.lang.Long

getProductSetId

public java.lang.Integer getProductSetId()
Returns the ProductSetId that represents the primary key of the product set.
Returns:
java.lang.Integer

getProductSetName

public java.lang.String getProductSetName()
Returns the Name of the product set.
Returns:
java.lang.String

setLanguageId

public void setLanguageId(java.lang.Integer newLanguageId)
Sets the LanguageId that represents the primary key of language of the product set description.
Parameters:
newLanguageId - java.lang.Integer

setProductSetDescription

public void setProductSetDescription(java.lang.String newProductSetDescription)
Sets the product set description.
Parameters:
newProductSetDescription - java.lang.String

setProductSetXml

public void setProductSetXml(java.lang.String newProductSetXml)
Sets the XML definition of the product set.
Parameters:
newProductSetXml - java.lang.String

setStatic

public void setStatic(java.lang.String newStatic)
Sets the static value of the product set. A static value of "1" indicates that this product set should not be re-published.
Parameters:
newProductSetXml - java.lang.String