com.ibm.commerce.catalogmanagement.commands

Interface ProductAttributeAddCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    ProductAttributeAddCmdImpl


    public interface ProductAttributeAddCmd
    extends ControllerCommand
    The ProductAttributeAddCmd is a URL and controller command that:
    • Adds a new product attribute to an exisiting catalog entry (Product) at the store default language.
    • Adds the product attribute to an existing catalog entry (Product) at a language other than the store default language. Product attribute at the store default language must exists before the attribute can be created at the secondary language.
    • By default, setDeleteItems is set to true, in which all items associated with the Product that the new attribute is creating to, will be deleted. Creating an existing on a secondary language will not delete the items.
    Parameters:
    • Unique index of the ATTRIBUTE table must be speicified. Most fields in the ATTRIBUTE table except for Market Place Edition related columns and IBM internal use columns. A new attribute ID will be returned at the end of successfully calling the command.
    • Attribute ID and Language ID must be supplied. Most fields in the ATTRIBUTE table except for Market Place Edition related columns and IBM internal use columns.
    • By default, setDeleteItem is set to true.
    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 Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
      • CLASSNAME

        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

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

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

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

        void setAttributeId(java.lang.Long anAttributeId)
        Sets the attribute ID.
      • setAttrLangId

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

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

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

        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

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

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

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

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

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

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

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

        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