com.ibm.commerce.catalogmanagement.commands
Interface ProductAttributeAddCmd

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

public interface ProductAttributeAddCmd
extends ControllerCommand

The ProductAttributeAddCmd is a URL and controller command that:

Parameters: Access Beans: AttributeAccessBean
Task Commands: AddAttributeCmd Other Controller Commands: None. Mandatory Parameters: catentryId, name, attrtypeId. Additional Parameters: None. Optional Parameters: desc, desc2, field1, descLangId, seq, usage, URL. Default Value: descLanguageId = langauge ID fromcommand contect.

Field Summary
static java.lang.String CLASSNAME
The name of this interface is "com.ibm.commerce.catalogmanagement.commands.ProductAttributeAddCmd".
static java.lang.String COPYRIGHT
The internal copyright field.
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
Method Summary
java.lang.Long getAttributeId()
Gets the attribute ID.
java.lang.Long getCatentryId()
Gets the catalog entry ID for the attribute.
java.lang.String getName()
Gets the name of the attribute.
void setAttributeId(java.lang.Long anAttributeId)
Sets the attribute ID.
void setAttrLangId(java.lang.Integer anAttrLangId)
Set the attribute language ID.
void setAttrtypeId(java.lang.String astrAttrtypeId)
Sets the attribute type ID.
void setCatentryId(java.lang.Long anCatentryId)
Sets the catalog entry ID for the attribute.
void setDeleteItems(java.lang.Boolean abDeleteItems)
Sets whether or not to delete the items when the attribute is created: True will delete all the items of the product when a new attribute is being created for the product.
void setDescription(java.lang.String astrDescription)
Sets the description of the attribute.
void setDescription2(java.lang.String astrDescription2)
Sets the secondary description of the attribute.
void setField1(java.lang.String astrField1)
Sets field 1 of the attribute.
void setName(java.lang.String astrName)
Sets the name of the attribute.
void setOID(java.lang.String astrOID)
Sets the object identifier of the attribute.
void setSequence(java.lang.Double anSequence)
Sets the sequence number of the attribute.
void setURL(java.lang.String astrURL)
Sets the redirect URL.
void setUsage(java.lang.String astrUsage)
Sets the usage of the attribute: NULL or "1" indicates SKU-resolution.
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
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.
See Also:
Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this interface is "com.ibm.commerce.catalogmanagement.commands.ProductAttributeAddCmd".
See Also:
Constant Field Values
Method Detail

getAttributeId

public java.lang.Long getAttributeId()
Gets the attribute ID.
Returns:
the attribute ID

getCatentryId

public java.lang.Long getCatentryId()
Gets the catalog entry ID for the attribute.
Returns:
the catalog entry ID

getName

public java.lang.String getName()
Gets the name of the attribute.
Returns:
the attribute name

setAttributeId

public void setAttributeId(java.lang.Long anAttributeId)
Sets the attribute ID.
Returns:
anAttributeId the attribute ID

setAttrLangId

public void setAttrLangId(java.lang.Integer anAttrLangId)
Set the attribute language ID.
Parameters:
anAttrLangId - the language ID

setAttrtypeId

public void setAttrtypeId(java.lang.String astrAttrtypeId)
Sets the attribute type ID. Attribute types included:
  • String
  • Integer
  • Float
Parameters:
astrAttrtypeId - the attribute type ID

setCatentryId

public void setCatentryId(java.lang.Long anCatentryId)
Sets the catalog entry ID for the attribute.
Parameters:
anCatentryId - catalog entry ID

setDeleteItems

public void setDeleteItems(java.lang.Boolean abDeleteItems)
Sets whether or not to delete the items when the attribute is created:
  • True will delete all the items of the product when a new attribute is being created for the product.
  • False will not delete the items of the product when a new attribute is being created for the product.
Parameters:
abDeleteItems - whether or not to delete the items when a new attribute is being created

setDescription

public void setDescription(java.lang.String astrDescription)
Sets the description of the attribute.
Parameters:
astrDescription - the description of the attribute

setDescription2

public void setDescription2(java.lang.String astrDescription2)
Sets the secondary description of the attribute.
Parameters:
astrDescription2 - the secondary description of the attribute

setField1

public void setField1(java.lang.String astrField1)
Sets field 1 of the attribute.
Parameters:
astrField1 - customizable field 1

setName

public void setName(java.lang.String astrName)
Sets the name of the attribute.
Parameters:
astrName - the attribute name

setOID

public void setOID(java.lang.String astrOID)
Sets the object identifier of the attribute.
Parameters:
astrOID - the object identifier of the attribute

setSequence

public void setSequence(java.lang.Double anSequence)
Sets the sequence number of the attribute.
Parameters:
anSequence - the sequence number

setURL

public void setURL(java.lang.String astrURL)
Sets the redirect URL.
Parameters:
astrURL - the redirect URL

setUsage

public void setUsage(java.lang.String astrUsage)
Sets the usage of the attribute:
  • NULL or "1" indicates SKU-resolution. A defining attribute.
  • "2" and any other characters indicates a descriptive attribute and should not be used to resolve SKUs.
Parameters:
astrUsage - the attribute usage

Feedback