com.ibm.commerce.catalogmanagement.commands

Interface CatalogEntryAddCmd

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

    public interface CatalogEntryAddCmd
extends ControllerCommand
    The CatalogEntryAddCmd is a URL and controller command that:
    • Adds a new catalog entry.
    • Adds a new catalog entry description.
    • If the new catalog entry is a Product, then a new baseitem, baseitem descripton, and a item version will be created.
    • If the new catalog entry is an item, then a new item specification, and a version specification will be created.
    • If the new catalog entry is a Package, then a new baseitem, baseitem description, item version, item specification, and version specification will be created.
    • If the new catalog entry is a Dynamic Kit, then a baseitem, baseitem description, item version, item specification, and version specification will be created.
    • If the new catalog entry is a Bundle, no new entries are required.
    • If the new catalog entry is a ProductItem, then a new baseitem, baseitem description, item version, item specification, and version specification will be created.
    • Calls CatEntryStoreRelAdd to create the store to catalog entry relationship.
    • If catalog ID and catalog Group ID are supplied, then calls CatGroupCatEntryRelAdd to create the catalog, catalog group, and catalog entry relationship.
    • If the new catalog entry is an Item, and the parent catalog entry ID is supplied, then calls CatEntryRelAdd to create the catalog entry to catalog entry relationship.
    Parameters:
    • All fields in the CATENTRY table, except IBM internal use columns.
    • All fields in the CATENTDESC table.
    • No fields required.
    • No fields required.
    • No fields required.
    • No fields required.
    • No fields required.
    • No fields required.
    • No fields required.
    • CatalogId, CatalogGroupId.
    • Parent CatalogEntryId.
    Access Beans:
    • CatalogEntry
    • CatalogEntryDescription
    • BaseItem, BaseItemDescription, ItemVersion.
    • ItemSpecification, VersionSpecification.
    • BaseItem, BaseItemDescription, ItemVersion, ItemSpecification, VersionSpecification.
    • BaseItem, BaseItemDescription, ItemVersion, ItemSpecification, VersionSpecification.
    • no new table is required
    • BaseItem, BaseIetmDescription, ItemVersion, ItemSpecification, VersionSpecification
    • see CatEntryStoreRelAdd command.
    • see CatGroupCatEntryRelAdd command.
    • see CatEntryRelAdd command.
    Task Commands:
    • AddCatalogEntryCmd,
    • AddCatalogEntryDescCmd
    Other Controller Commands:
    • CatEntryStoreRelAddCmd,
    • CatEntryRelAddCmd,
    • CatGroupCatEntryRelAddCmd
    Mandatory Parameters
    partnumber + catenttypeId, or catentryId. catentryId is accepted only if this catlaog entry already exists, and a new description is being added.
    Additional Parameters
    (catalogId + catgroupId), catentryIdParent
    Optional Parameters
    buyable, field1, field2, field3, field4, field5, keyword, markForDelete, mfName, mfPartnumber, onAuction, onSpecial, catEntURL, aux1, aux2, available, fImage, lDesc, name, published, sDesc, tImage, XML,descLangId, URL, startDate, endDate, availabilityDate, lastOrderDate, endOfServiceDate, discontinueDate.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      The name of this interface is "com.ibm.commerce.catalogmanagement.commands.CatalogEntryAddCmd".
      static java.lang.String COPYRIGHT
      The internal copyright field.

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID

    • 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.CatalogEntryAddCmd".
        See Also:
        Constant Field Values

    • Method Detail

      • setAuxdescription1

        void setAuxdescription1(java.lang.String astrAuxdescription1)
        Sets the first language dependent additional description for the catalog entry.
        Parameters:
        astrAuxdescription1 - the first auxiliary description for the catalog entry

      • setAuxdescription2

        void setAuxdescription2(java.lang.String astrAuxdescription2)
        Sets the second language dependent additional description for the catalog entry.
        Parameters:
        astrAuxdescription2 - the second auxiliary description for the catalog entry

      • setAvailabilitydate

        void setAvailabilitydate(java.sql.Timestamp atmAvailabilitydate)
        Sets the availability date for the catalog entry.
        Parameters:
        atmAvailabilitydate - the date the catalog entry becomes available

      • setAvailable

        void setAvailable(java.lang.Integer anAvailable)
        Sets the length of time to availability of the catalog entry.
        Parameters:
        anAvailable - the length of time before the catalog entry becomes available

      • getCatentryId

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

      • getPartnumber

        java.lang.String getPartnumber()
        Gets the partnumber of the catalog entry.
        Returns:
        the catalog entry partnumber

      • setBuyable

        void setBuyable(java.lang.Integer anBuyable)
        Whether you can purchase the catalog entry:
        • 0 = Non Buyable
        • 1 = Buyable
        Parameters:
        anBuyable - the buyable option of the catalog entry

      • setCatalogId

        void setCatalogId(java.lang.Long anCatalogId)
        Sets the catalog ID for the catalog, catalog group, and catalog entry relationship.
        Parameters:
        anCatalogId - the catalog ID

      • setCatentryId

        void setCatentryId(java.lang.Long anCatentryId)
        Sets the catalog entry ID to create a new catalog entry description.
        Parameters:
        anCatentryId - the catalog entry ID

      • setCatentryIdParent

        void setCatentryIdParent(java.lang.Long anCatentryIdParent)
        Sets the parent catalog entry ID of the catalog entry. This is the parent of the new catalog entry. A parent catalog entry to child catalog entry relationship will be created.
        Parameters:
        anCatentryIdParent - the parent catalog entry ID

      • setCatenttypeId

        void setCatenttypeId(java.lang.String astrCatenttypeId)
        Sets the catalog entry type ID of the catalog entry. Catalog entry type IDs supported by catalog management API are:
        • ProductBean
        • ItemBean
        • PackageBean
        • BundleBean
        • DynamicKitBean
        Parameters:
        astrCatenttypeId - the catalog entry type ID

      • setCatEntURL

        void setCatEntURL(java.lang.String astrCatEntURL)
        Sets the URL location of the catalog entry.
        Parameters:
        astrCatEntURL - URL of the catalog entry

      • setCatgroupId

        void setCatgroupId(java.lang.Long anCatgroupId)
        Sets the catalog group ID for the catalog, catalog group, and catalog entry relationship.
        Parameters:
        anCatgroupId - the catalog group ID

      • setDescLanguage

        void setDescLanguage(java.lang.Integer anDescLang)
              throws ECException
        Set the language ID used for the catalog entry description.
        Parameters:
        anDescLang - the language ID
        Throws:
        ECException

      • setEndDate

        void setEndDate(java.sql.Timestamp atmEndDate)
        Sets the end date that the catalog entry is no longer offered.
        Parameters:
        atmEndDate - the end date

      • setExpirationdate

        void setExpirationdate(java.sql.Timestamp atmExpirationdate)
        Sets the expiration date for the catalog entry.
        Parameters:
        atmExpirationdate - the expiration date

      • setField1

        void setField1(java.lang.Integer anField1)
        Sets field 1 of the catalog entry.
        Parameters:
        anField1 - customizable field1

      • setField2

        void setField2(java.lang.Integer anField2)
        Sets field 2 of the catalog entry.
        Parameters:
        anField2 - customizable field 2

      • setField3

        void setField3(java.math.BigDecimal adField3)
        Sets field 3 of the catalog entry.
        Parameters:
        adField3 - customizable field 3

      • setField4

        void setField4(java.lang.String astrField4)
        Sets field 4 of the catalog entry.
        Parameters:
        astrField4 - customizable field 4

      • setField5

        void setField5(java.lang.String astrField5)
        Sets field 5 of the catalog entry.
        Parameters:
        astrField5 - customizable field 5

      • setFullimage

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

      • setKeyword

        void setKeyword(java.lang.String astrKeyword)
        Sets the keyword of the catalog entry.
        Parameters:
        astrKeyword - the catalog entry keyword

      • setLongdescription

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

      • setMarkfordelete

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

      • setMemberId

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

      • setMfname

        void setMfname(java.lang.String astrMfname)
        Sets the name of the manufacturer for the catalog entry.
        Parameters:
        astrMfname - the manufacturer name of the catalog entry

      • setMfpartnumber

        void setMfpartnumber(java.lang.String astrMfpartnumber)
        Sets the part number of the catalog entry used by the manufacturer.
        Parameters:
        astrMfpartnumber - the manufacturer partnumber of the catalog entry

      • setName

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

      • setOnauction

        void setOnauction(java.lang.Integer anOnauction)
        Sets whether or not the catalog entry is on auction:
        • 0 = Not on auction.
        • 1 = On auction.
        Parameters:
        anOnauction - the auction flag of the catalog entry

      • setOnspecial

        void setOnspecial(java.lang.Integer anOnspecial)
        Sets whether or not the catalog entry is on special:
        • 0 = Not on special.
        • 1 = On special.
        Parameters:
        anOnspecial - the special status flag for the catalog entry

      • setPartnumber

        void setPartnumber(java.lang.String astrPartnumber)
        Sets the partnumber of the catalog entry.
        Parameters:
        astrPartnumber - the catalog entry partnumber

      • setPublished

        void setPublished(java.lang.Integer anPublished)
        Sets whether or not the catalog entry description has been published:
        • 0 = catalog entry not published.
        • 1 = catalog entry published.
        Parameters:
        anPublished - the published flag of the catalog entry description

      • setShortdescription

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

      • setStartDate

        void setStartDate(java.sql.Timestamp atmstartDate)
        Sets the start date for the catalog entry.
        Parameters:
        atmStartDate - the start date of the catalog entry

      • setAvailabilityDate

        void setAvailabilityDate(java.sql.Timestamp atmavailabilityDate)
        Sets the availability date for the catalog entry.
        Parameters:
        atmAvailabilityDate - the availability date of the catalog entry

      • setLastOrderDate

        void setLastOrderDate(java.sql.Timestamp atmlastOrderDate)
        Sets the lastOrder date for the catalog entry.
        Parameters:
        atmLastOrderDate - the lastOrder date of the catalog entry

      • setEndOfServiceDate

        void setEndOfServiceDate(java.sql.Timestamp atmendOfServiceDate)
        Sets the endOfService date for the catalog entry.
        Parameters:
        atmEndOfServiceDate - the endOfService date of the catalog entry

      • setDiscontinueDate

        void setDiscontinueDate(java.sql.Timestamp atmdiscontinueDate)
        Sets the discontinue date for the catalog entry.
        Parameters:
        atmDiscontinueDate - the discontinue date of the catalog entry

      • setThumbnail

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

      • setURL

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

      • setXMLdetail

        void setXMLdetail(java.lang.String astrXMLdetail)
        Sets the XML detail of the catalog entry.
        Parameters:
        astrXMLdetail - the XML detail of the catalog entry

      • setSequenceForCatgpenrel

        void setSequenceForCatgpenrel(java.lang.Double adSequenceForCatgpenrel)
        Sets the sequence number for the parent catalog entry to child catalog entry relationship.
        Parameters:
        adSequenceForCatentrel - the sequence number for the parent to child catalog entry relationship

      • setSequenceForCatentrel

        void setSequenceForCatentrel(java.lang.Double adSequenceForCatentrel)
        Sets the sequence number for the catalog, catalog group, and catalog entry relationship.
        Parameters:
        adSequenceForCatgpenrel - the sequence number for the catalog to catalog group to catalog entry relationship

      • getCatalogId

        java.lang.Long getCatalogId()
        Gets the catalog ID for the catalog entry in the catalog, catalog group, and catalog entry relationship
        Returns:
        the catalog ID

      • getCatentryIdParent

        java.lang.Long getCatentryIdParent()
        Gets the parent catalog entry ID for the catalog entry to catalog entry relationship.
        Returns:
        the parent catalog entry ID

      • getCatgroupId

        java.lang.Long getCatgroupId()
        Gets the catalog group ID for the catalog entry in the catalog, catalog group, and catalog entry relationship.
        Returns:
        the catalog group ID
Skip navigation links