com.ibm.commerce.productset.commands
Interface ProductSetPolicyAddCmd

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

public interface ProductSetPolicyAddCmd
extends ControllerCommand

Add a product set policy.

Input parameters:
NameTypeRequirementDescription
productSetXmlStringoptionalThe XML string of the product set definition.
productSetDescriptionStringoptionalThe description of the product set.
nameStringoptionalThe name of the product set policy.
policyDescriptionStringoptionalThe description of the product set policy.
languageIdIntegeroptionalThe language of the description.
catalogIdLongoptionalThe catalog ID.
categoryIdLongoptionalThe category ID.

Output parameters:
NameTypeDescription
productSetIdIntegerThe newly created product set's ID.
productSetNameStringThe newly created product set's name.
policyIdLongThe newly created product set policy's ID.
policyNameStringThe newly created product set policy's name.

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 getPolicyId()
          Returns the PolicyId that represents the primary key of the policy.
 java.lang.String getPolicyName()
          Returns the name of the policy.
 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 setCatalogId(java.lang.Long newCatalogId)
          Sets the CatalogId that represents the primary key of the catalog.
 void setCatGroupId(java.lang.Long newCatGroupId)
          Sets the CatalogGroupId (CategoryId) that represents the primary key of the category.
 void setLanguageId(java.lang.Integer newLanguageId)
          Sets the LanguageId that represents the primary key of language of the description.
 void setPolicyName(java.lang.String newPolicyName)
          Sets the name of the policy.
 void setProductSetDescription(java.lang.String newProductSetDescription)
          Sets the description of the product set.
 void setProductSetXml(java.lang.String newProductSetXml)
          Sets the XML definition 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

getPolicyId

public java.lang.Long getPolicyId()
Returns the PolicyId that represents the primary key of the policy.
Returns:
java.lang.Long

getPolicyName

public java.lang.String getPolicyName()
Returns the name of the policy.
Returns:
java.lang.String

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

setCatalogId

public void setCatalogId(java.lang.Long newCatalogId)
Sets the CatalogId that represents the primary key of the catalog.
Parameters:
newCatalogId - java.lang.Long

setCatGroupId

public void setCatGroupId(java.lang.Long newCatGroupId)
Sets the CatalogGroupId (CategoryId) that represents the primary key of the category.
Parameters:
newCatGroupId - java.lang.Long

setLanguageId

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

setPolicyName

public void setPolicyName(java.lang.String newPolicyName)
Sets the name of the policy.
Parameters:
newPolicyName - java.lang.String

setProductSetDescription

public void setProductSetDescription(java.lang.String newProductSetDescription)
Sets the description of the product set.
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