com.ibm.commerce.catalogmanagement.commands

Interface ProductAttributeDeleteCmd

  • 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:
    ProductAttributeDeleteCmdImpl


    public interface ProductAttributeDeleteCmd
    extends ControllerCommand
    The ProductAttributeDeleteCmd is a URL and controller command that:
    • If the attribute ID is supplied:
      • Deletes an existing product attribute,
      • By default, it will call CatalogEntryDeleteCmd for all the items with the deleting attribute.
        • Sets setDeleteItems to false if items of the product are not to be deleted when deleting the product attribute.
    • If the catalog entry ID for the product is supplied:
      • Deletes all product attributes related to that catalog entry.
      • By default, it will call CatalogEntryDeleteCmd for all the items of the product.
        • Sets setDeleteItems to false if items of the product are not to be deleted when deleting the product attribute.
    Parameters:
    • attribute ID
    • catalog entry ID
    Access Beans:
    • AttributeAccessBean
    • AttributeAccessBean
    Task Commands: DeleteAttributeCmd
    Other Controller Commands: None.
    Mandatory Parameters: attributeId, or catentryId and name.
    Additional Parameters: None.
    Optional Parameters: descLangId, force, URL.
    • 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.ProductAttributeDeleteCmd".
        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.
        Returns:
        the catalog entry ID
      • setAttributeId

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

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

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

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

        void setForce(java.lang.Integer anForce)
        Sets the force delete option for the attribute:
        • 0 = items will be marked for deletion.
        • 1 = items will be deleted.
        Parameters:
        anForce - the force option to be passed to CatalogEntryDeleteCmd
      • setDeleteItems

        void setDeleteItems(java.lang.Boolean abDeleteItems)
        Sets whether or not to delete the items associated with the product when deleting the attribute:
        • True = items will be deleted
        • False = items will not be deleted
        By default, it is set to true to delete items
        Parameters:
        abDeleteItems - the option to delete the items associated with the product attribute
      • setName

        void setName(java.lang.String astrName)
        Sets the attribute name.
        Parameters:
        astrName - the attribute name
      • 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