com.ibm.commerce.catalogmanagement.commands

Interface CatalogGroupAddCmd

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

    public interface CatalogGroupAddCmd
extends ControllerCommand
    The CatalogGroupAddCmd is a URL and controller command that:
    • Adds a new Catalog Group. If the catalog group is new, then the catalog group ID cannot be set.
    • Adds a new Catalog Group description.
    • Adds a relationship between the new Catalog Group and the Store.
    • Adds a relationship with the specificed Catalog and parent Catalog Group.
    Parameters:
    • All fields in the CATGROUP table, except IBM internal use field and the CATGROUP.LASTUPDATE column.
    • All fields in the CATGRPDESC table.
    • No field required.
    • catalogId, catgroupIdParent.
    Access Beans:
    • CatalogGroupAccessBean
    • CatalogGroupDescriptionAccessBean
    • StoreCatalogGroupAccessBean
    • CatalogGroupRelationAccessBean
    Task Commands:
    • AddCatalogGroup,
    • AddCatalogGroupDescCmd.
    Other Controller Commands:
    • CatGroupStoreRelAddCmd,
    • CatGroupRelAddCmd.
    Mandatory Parameters: identifier, or catgroupId (if adding Catalog Group Description).
    Additional Parameters: (catalogId + catgroupIdParent).
    Optional Parameters: field1, field2, markForDelete, display, name, published, keyword, fImage, descLangId, lDesc, sDesc, tImage, 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
        Defines the CLASSNAME.
        See Also:
        Constant Field Values

    • Method Detail

      • setCatalogId

        void setCatalogId(java.lang.Long anCatalogId)
        Sets the catalog ID. Together with the catgroupIdParent, the newly created catalog group will be the child of the catgroupIdParent in this catalog.
        Parameters:
        anCatalogId - the catalog ID

      • getCatgroupId

        java.lang.Long getCatgroupId()
        Gets the catalog group ID. The ID of the newly created catalog group.
        Returns:
        the catalog group ID

      • getIdentifier

        java.lang.String getIdentifier()
        Gets the catalog group identifier.
        Returns:
        the catalog group identifier

      • setCatgroupId

        void setCatgroupId(java.lang.Long anCatgroupId)
        Sets the catalog group ID for the description.
        Parameters:
        anCatgroupId - the catalog group ID

      • setIdentifier

        void setIdentifier(java.lang.String astrIdentifier)
        Sets the catalog group identifier.
        Parameters:
        astrIdentifier - the identifier of the catalog group

      • setCatgroupIdParent

        void setCatgroupIdParent(java.lang.Long anCatgroupIdParent)
        Sets the parent catalog group ID for the catalog, parent catalog group, and child catalog group relationship.
        Parameters:
        anCatgroupIdParent - the parent catalog group ID

      • setDescLanguage

        void setDescLanguage(java.lang.Integer anDescLang)
        Sets the language ID for the catalog group description.
        Parameters:
        anDescLang - the language ID

      • setDisplay

        void setDisplay(java.lang.String astrDisplay)
        Sets the display for the catalog group.
        Parameters:
        astrDisplay - the display for the catalog group

      • setField1

        void setField1(java.lang.String astrField1)
        Sets the field 1 in the catalog group description.
        Parameters:
        astrField1 - customizable field 1

      • setField2

        void setField2(java.lang.String astrField2)
        Sets the field 2 in the catalog group description.
        Parameters:
        astrField2 - customizable field 2

      • setFullimage

        void setFullimage(java.lang.String astrFullimage)
        Sets the path of the full image of catalog group.
        Parameters:
        astrFullimage - the full image of the catalog group

      • setKeyword

        void setKeyword(java.lang.String astrKeyword)
        Sets the language dependent keyword for the catalog group.
        Parameters:
        astrKeyword - the keyword for catalog group

      • setLastupdate

        void setLastupdate(java.sql.Timestamp atmLastupdate)
        Sets the date and time when the catalog group was updated. If not specified, the time the command was called will be used.
        Parameters:
        atmLastupdate - the timestamp when the catalog group was last updated.

      • setLongdescription

        void setLongdescription(java.lang.String astrLongdescription)
        Sets the long description of the catalog group.
        Parameters:
        astrLongdescription - the long description of the catalog group

      • setMarkfordelete

        void setMarkfordelete(java.lang.Integer anMarkfordelete)
        Sets the mark for delete flag for the catalog group:
        • 1 = marked for delete.
        • 0 or null = not mark for delete.
        Parameters:
        anMarkfordelete - the mark for delete flag for the catalog group

      • setMemberId

        void setMemberId(java.lang.Long anMemberId)
        Sets the owner ID of the catalog group.
        Parameters:
        anMemberId - the owner of the catalog group

      • setName

        void setName(java.lang.String astrName)
        Sets the language dependent name of the catalog group.
        Parameters:
        astrName - the catalog group name

      • setOID

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

      • setPublished

        void setPublished(java.lang.Integer anPublished)
        Sets whether the catalog group should be displayed in the specified language. The published flag of the catalog group description:
        • 0 = Not published.
        • 1 = Published.
        Parameters:
        anPublished - the publish flag of the catalog group description in the specified language

      • setShortdescription

        void setShortdescription(java.lang.String astrShortdescription)
        Sets the short description of the catalog group.
        Parameters:
        astrShortdescription - the short description of the catalog group

      • setThumbnail

        void setThumbnail(java.lang.String astrThumbnail)
        Sets the path of the thumbnail image of the catalog group.
        Parameters:
        astrThumbnail - the thumbnail image of the catalog group

      • setNote

        void setNote(java.lang.String astrNote)
        Set the footnote of the catalog group description
        Parameters:
        astrNote - Footnote of the catalog group

      • setSequenceForCatgrprel

        void setSequenceForCatgrprel(java.lang.Double adSequenceForCatgrprel)
        Sets the sequence number for the catalog, parent catalog group, and child catalog group relationship. This is used when catalogId and catalogIdParent is supplied.
        Parameters:
        adSequenceForCatgrprel - the sequence number for the catalog, parent catalog group, and child catalog group relationship

      • setURL

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