com.ibm.commerce.catalogmanagement.commands
Interface CatalogEntryAddCmd

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

public interface CatalogEntryAddCmd
extends ControllerCommand

Command Name: CatalogEntryAdd Command Type: URL and Controller Command Description: 1. Adds a new Catalog Entry. 2. Adds a new Catalog Entry Description. 3. If the new Catalog Entry is a Product, then add a new Base Item, a new Base Item Descripton, and a new Item Version. 4. If the new Catalog Entry is an Item, then add a new Item Specification, an a new Version Specification. 5. Call CatEntryStoreRelAdd. 6. If Catalog and Catalog Group are supplied, then call CatGroupCatEntryRelAdd 7. If the new Catalog Entry is an Item, and the parent Catalog Entry is supplied, then call CatEntryRelAdd. Parameters: 1. All fields in the CatalogEntry table, except IBM internal use columns. 2. All fields in the CatEntDesc table. 3. No fields required. 4. No fields required. 5. No fields required. 6. CatalogId, CatalogGroupId. 7. Parent CatalogEntryId. Tables: 1. Catentry. 2. Catentdesc. 3. BaseItem, BaseItmDsc, ItemVersn. 4. ItemSpc, VersionSpc. 5. See CatEntryStoreRelAdd command. 6. See CatGroupCatEntryRelAdd command. 7. See CatEntryRelAdd command. Task Commands: AddCatalogEntryCmd, AddCatalogEntryDescCmd Other Controller Commands: CatEntryStoreRelAddCmd, CatEntryRelAddCmd, CatGroupCatEntryRelAddCmd Mandatory Parameters: partnumber + catenttypeId, or catentryId (if Catlaog Entry alreadt exists, adding new description) 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,


Field Summary
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.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.Long getCatentryId()
          Get the catalog entry Id
 java.lang.String getPartnumber()
          Get the partnumber of the catalog entry
 void setAuxdescription1(java.lang.String astrAuxdescription1)
          Set auxdescription 1 that represent the first additional description for the catalog entry
 void setAuxdescription2(java.lang.String astrAuxdescription2)
          Set auxdescription 2 that represent the second additional description for the catalog entry
 void setAvailabilitydate(java.sql.Timestamp atmAvailabilitydate)
          Set availabledate that represent the availability date for the catalog entry
 void setAvailable(java.lang.Integer anAvailable)
          Set available that represent the length of time to availability of the catalog entry
 void setBuyable(java.lang.Integer anBuyable)
          Set the buyable for the catalog entry, the buyable can be: 0 - Non Buyable 1 - Buyable
 void setCatalogId(java.lang.Long anCatalogId)
          Set the CatalogId that represent the catalog of the catalog entry in the catalog, catalog group, catalog entry relationship
 void setCatentryId(java.lang.Long anCatentryId)
          Set the CatentryId that represent the primary key of the catalog entry
 void setCatentryIdParent(java.lang.Long anCatentryIdParent)
          Set CatentryIdParent that represent the parent catalog entry Id of the catalog entry in the parent catalog entry, child catalog entry relationship
 void setCatenttypeId(java.lang.String astrCatenttypeId)
          Set the CatenttypeId that represent the catalog entry type Id of the catalog entry catalog entry type Id fully supported by Catalog Management API are: 1.
 void setCatEntURL(java.lang.String astrCatEntURL)
          Set the CatEntURL that represent the URL location of the catalog entry
 void setCatgroupId(java.lang.Long anCatgroupId)
          Set the CatgroupId that represent the catalog group Id of the Catalog Entry in the catalog, catalog group, catalog entry relationship
 void setDescLanguage(java.lang.Integer anDescLang)
          Set DescLanguage that represent the language Id use for the catalog entry description
 void setExpirationdate(java.sql.Timestamp atmExpirationdate)
          Set the expiration date for the catalog entry
 void setField1(java.lang.Integer anField1)
          Set field 1 of the catalog entry
 void setField2(java.lang.Integer anField2)
          Set field 2 of the catalog entry
 void setField3(java.math.BigDecimal adField3)
          Set field 3 of the catalog entry
 void setField4(java.lang.String astrField4)
          Set field 4 of the catalog entry
 void setField5(java.lang.String astrField5)
          Set field 5 of the catalog entry
 void setFullimage(java.lang.String astrFullimage)
          Set Fullimage that represent the path of the full image of the catalog entry
 void setKeyword(java.lang.String astrKeyword)
          Set the keyword for the catalog entry
 void setLongdescription(java.lang.String astrLongdescription)
          Set the long description that represent a long description of the catalog entry
 void setMarkfordelete(java.lang.Integer anMarkfordelete)
          Set the mark for delete flag for the catalog entry 0 = catalog entry not marked for delete 1 = catalog entry marked for delete
 void setMemberId(java.lang.Long anMemberId)
          Set MemberId that represent the owner Id of the catalog entry
 void setMfname(java.lang.String astrMfname)
          Set Mfanme that represent the name of the manufacturer for the catalog entry
 void setMfpartnumber(java.lang.String astrMfpartnumber)
          Set Mfpartnumber that represent the part number of the catalog entry used by the manufacturer
 void setName(java.lang.String astrName)
          Set Name that represent a language dependent name of the catalog entry
 void setOnauction(java.lang.Integer anOnauction)
          Set Onauction that represent if the catalog entry is on auction.
 void setOnspecial(java.lang.Integer anOnspecial)
          Set Onspecial that represent if the catalog entry is on special.
 void setPartnumber(java.lang.String astrPartnumber)
          Set Partnumber that represent the partnumber of the catalog entry
 void setPublished(java.lang.Integer anPublished)
          Set Published that represented whether the catalog entry description has been published or not.
 void setSequenceForCatentrel(java.lang.Double adSequenceForCatentrel)
          Set the sequence number between the new catalog entry and the supplied catalog group
 void setSequenceForCatgpenrel(java.lang.Double adSequenceForCatgpenrel)
          Set the sequence number between the new catalog entry and the supplied parent catalog entry
 void setShortdescription(java.lang.String astrShortdescription)
          Set Shortdescription that represent a short description of the catalog entry
 void setThumbnail(java.lang.String astrThumbnail)
          Set Thumbnail that represent the path of the thumbnail image of the catalog entry
 void setURL(java.lang.String astrURL)
          Set URL that represent the redirect URL
 void setXMLdetail(java.lang.String astrXMLdetail)
          Set XMLdetail that represent the XML detail of the catalog entry
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this interface is "com.ibm.commerce.catalogmanagement.commands.CatalogEntryAddCmd".

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.
Method Detail

getCatentryId

public java.lang.Long getCatentryId()
Get the catalog entry Id
Returns:
java.lang.Long

getPartnumber

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

setAuxdescription1

public void setAuxdescription1(java.lang.String astrAuxdescription1)
Set auxdescription 1 that represent the first additional description for the catalog entry
Parameters:
astrAuxdescription1 - java.lang.String

setAuxdescription2

public void setAuxdescription2(java.lang.String astrAuxdescription2)
Set auxdescription 2 that represent the second additional description for the catalog entry
Parameters:
astrAuxdescription2 - java.lang.String

setAvailabilitydate

public void setAvailabilitydate(java.sql.Timestamp atmAvailabilitydate)
Set availabledate that represent the availability date for the catalog entry
Parameters:
atmAvailabilitydate - java.sql.Timestamp

setAvailable

public void setAvailable(java.lang.Integer anAvailable)
Set available that represent the length of time to availability of the catalog entry
Parameters:
anAvailable - java.lang.Integer

setBuyable

public void setBuyable(java.lang.Integer anBuyable)
Set the buyable for the catalog entry, the buyable can be:
Parameters:
anBuyable - java.lang.Integer

setCatalogId

public void setCatalogId(java.lang.Long anCatalogId)
Set the CatalogId that represent the catalog of the catalog entry in the catalog, catalog group, catalog entry relationship
Parameters:
anCatalogId - java.lang.Long

setCatentryId

public void setCatentryId(java.lang.Long anCatentryId)
Set the CatentryId that represent the primary key of the catalog entry
Parameters:
anCatentryId - java.lang.Long

setCatentryIdParent

public void setCatentryIdParent(java.lang.Long anCatentryIdParent)
Set CatentryIdParent that represent the parent catalog entry Id of the catalog entry in the parent catalog entry, child catalog entry relationship
Parameters:
anCatentryIdParent - java.lang.Long

setCatenttypeId

public void setCatenttypeId(java.lang.String astrCatenttypeId)
Set the CatenttypeId that represent the catalog entry type Id of the catalog entry catalog entry type Id fully supported by Catalog Management API are: 1. ProductBean 2. ItemBean Other possible catalog entry type Id include: 3. PackageBean 4. BundleBean 5. DynamicKitBean However, these types are not fully supported by the Catalog Management API
Parameters:
astrCatenttypeId - java.lang.String

setCatEntURL

public void setCatEntURL(java.lang.String astrCatEntURL)
Set the CatEntURL that represent the URL location of the catalog entry
Parameters:
astrCatEntURL - java.lang.String

setCatgroupId

public void setCatgroupId(java.lang.Long anCatgroupId)
Set the CatgroupId that represent the catalog group Id of the Catalog Entry in the catalog, catalog group, catalog entry relationship
Parameters:
anCatgroupId - java.lang.Long

setDescLanguage

public void setDescLanguage(java.lang.Integer anDescLang)
                     throws ECException
Set DescLanguage that represent the language Id use for the catalog entry description
Parameters:
anDescLang - java.lang.Integer

setExpirationdate

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

setField1

public void setField1(java.lang.Integer anField1)
Set field 1 of the catalog entry
Parameters:
anField1 - java.lang.Integer

setField2

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

setField3

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

setField4

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

setField5

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

setFullimage

public void setFullimage(java.lang.String astrFullimage)
Set Fullimage that represent the path of the full image of the catalog entry
Parameters:
astrFullimage - java.lang.String

setKeyword

public void setKeyword(java.lang.String astrKeyword)
Set the keyword for the catalog entry
Parameters:
astrKeyword - java.lang.String

setLongdescription

public void setLongdescription(java.lang.String astrLongdescription)
Set the long description that represent a long description of the catalog entry
Parameters:
astrLongdescription - java.lang.String

setMarkfordelete

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

setMemberId

public void setMemberId(java.lang.Long anMemberId)
Set MemberId that represent the owner Id of the catalog entry
Parameters:
anMemberId - java.lang.Long

setMfname

public void setMfname(java.lang.String astrMfname)
Set Mfanme that represent the name of the manufacturer for the catalog entry
Parameters:
astrMfname - java.lang.String

setMfpartnumber

public void setMfpartnumber(java.lang.String astrMfpartnumber)
Set Mfpartnumber that represent the part number of the catalog entry used by the manufacturer
Parameters:
astrMfpartnumber - java.lang.String

setName

public void setName(java.lang.String astrName)
Set Name that represent a language dependent name of the catalog entry
Parameters:
astrName - java.lang.String

setOnauction

public void setOnauction(java.lang.Integer anOnauction)
Set Onauction that represent if the catalog entry is on auction.
Parameters:
anOnauction - java.lang.Integer

setOnspecial

public void setOnspecial(java.lang.Integer anOnspecial)
Set Onspecial that represent if the catalog entry is on special.
Parameters:
anOnspecial - java.lang.Integer

setPartnumber

public void setPartnumber(java.lang.String astrPartnumber)
Set Partnumber that represent the partnumber of the catalog entry
Parameters:
astrPartnumber - java.lang.String

setPublished

public void setPublished(java.lang.Integer anPublished)
Set Published that represented whether the catalog entry description has been published or not.
  • 0 = catalog entry not published
  • 1 = catalog entry published
  • Parameters:
    anPublished - java.lang.Integer

    setSequenceForCatentrel

    public void setSequenceForCatentrel(java.lang.Double adSequenceForCatentrel)
    Set the sequence number between the new catalog entry and the supplied catalog group
    Parameters:
    adSequenceForCatgpenrel - java.lang.Double

    setSequenceForCatgpenrel

    public void setSequenceForCatgpenrel(java.lang.Double adSequenceForCatgpenrel)
    Set the sequence number between the new catalog entry and the supplied parent catalog entry
    Parameters:
    adSequenceForCatentrel - java.lang.Double

    setShortdescription

    public void setShortdescription(java.lang.String astrShortdescription)
    Set Shortdescription that represent a short description of the catalog entry
    Parameters:
    astrShortdescription - java.lang.String

    setThumbnail

    public void setThumbnail(java.lang.String astrThumbnail)
    Set Thumbnail that represent the path of the thumbnail image of the catalog entry
    Parameters:
    astrThumbnail - java.lang.String

    setURL

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

    setXMLdetail

    public void setXMLdetail(java.lang.String astrXMLdetail)
    Set XMLdetail that represent the XML detail of the catalog entry
    Parameters:
    astrXMLdetail - java.lang.String