com.ibm.commerce.catalogmanagement.commands
Interface CatalogEntryAddCmd

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

public interface CatalogEntryAddCmd
extends ControllerCommand

The CatalogEntryAddCmd is a URL and controller command that:

Parameters: Access Beans: Task Commands: Other Controller Commands: Mandatory Parameters: partnumber + catenttypeId, or catentryId (catentryId is accepted only if catlaog entry alreadt 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.

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 getCatalogId()
          Gets the catalog ID for the catalog entry in the catalog, catalog group, and catalog entry relationship
 java.lang.Long getCatentryId()
          Gets the catalog entry ID.
 java.lang.Long getCatentryIdParent()
          Gets the parent catalog entry ID for the catalog entry to catalog entry relationship.
 java.lang.Long getCatgroupId()
          Gets the catalog group ID for the catalog entry in the catalog, catalog group, and catalog entry relationship.
 java.lang.String getPartnumber()
          Gets the partnumber of the catalog entry.
 void setAuxdescription1(java.lang.String astrAuxdescription1)
          Sets the first language dependent additional description for the catalog entry.
 void setAuxdescription2(java.lang.String astrAuxdescription2)
          Sets the second language dependent additional description for the catalog entry.
 void setAvailabilitydate(java.sql.Timestamp atmAvailabilitydate)
          Sets the availability date for the catalog entry.
 void setAvailable(java.lang.Integer anAvailable)
          Sets the length of time to availability of the catalog entry.
 void setBuyable(java.lang.Integer anBuyable)
          Whether you can purchase the catalog entry: 0 = Non Buyable 1 = Buyable
 void setCatalogId(java.lang.Long anCatalogId)
          Sets the catalog ID for the catalog, catalog group, and catalog entry relationship.
 void setCatentryId(java.lang.Long anCatentryId)
          Sets the catalog entry ID to create a new catalog entry description.
 void setCatentryIdParent(java.lang.Long anCatentryIdParent)
          Sets the parent catalog entry ID of the catalog entry.
 void setCatenttypeId(java.lang.String astrCatenttypeId)
          Sets the catalog entry type ID of the catalog entry.
 void setCatEntURL(java.lang.String astrCatEntURL)
          Sets the URL location of the catalog entry.
 void setCatgroupId(java.lang.Long anCatgroupId)
          Sets the catalog group ID for the catalog, catalog group, and catalog entry relationship.
 void setDescLanguage(java.lang.Integer anDescLang)
          Set the language ID used for the catalog entry description.
 void setEndDate(java.sql.Timestamp atmEndDate)
          Sets the end date that the catalog entry is no longer offered.
 void setExpirationdate(java.sql.Timestamp atmExpirationdate)
          Sets the expiration date for the catalog entry.
 void setField1(java.lang.Integer anField1)
          Sets field 1 of the catalog entry.
 void setField2(java.lang.Integer anField2)
          Sets field 2 of the catalog entry.
 void setField3(java.math.BigDecimal adField3)
          Sets field 3 of the catalog entry.
 void setField4(java.lang.String astrField4)
          Sets field 4 of the catalog entry.
 void setField5(java.lang.String astrField5)
          Sets field 5 of the catalog entry.
 void setFullimage(java.lang.String astrFullimage)
          Sets the path of the full image of the catalog entry.
 void setKeyword(java.lang.String astrKeyword)
          Sets the keyword of the catalog entry.
 void setLongdescription(java.lang.String astrLongdescription)
          Sets the language dependent long description of the catalog entry.
 void setMarkfordelete(java.lang.Integer anMarkfordelete)
          Sets the mark for delete flag for the catalog entry: 0 = catalog entry not marked for delete.
 void setMemberId(java.lang.Long anMemberId)
          Set the owner ID of the catalog entry.
 void setMfname(java.lang.String astrMfname)
          Sets the name of the manufacturer for the catalog entry.
 void setMfpartnumber(java.lang.String astrMfpartnumber)
          Sets the part number of the catalog entry used by the manufacturer.
 void setName(java.lang.String astrName)
          Sets the language dependent name of the catalog entry.
 void setOnauction(java.lang.Integer anOnauction)
          Sets whether or not the catalog entry is on auction: 0 = Not on auction. 1 = On auction.
 void setOnspecial(java.lang.Integer anOnspecial)
          Sets whether or not the catalog entry is on special: 0 = Not on special. 1 = On special.
 void setPartnumber(java.lang.String astrPartnumber)
          Sets the partnumber of the catalog entry.
 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.
 void setSequenceForCatentrel(java.lang.Double adSequenceForCatentrel)
          Sets the sequence number for the catalog, catalog group, and catalog entry relationship.
 void setSequenceForCatgpenrel(java.lang.Double adSequenceForCatgpenrel)
          Sets the sequence number for the parent catalog entry to child catalog entry relationship.
 void setShortdescription(java.lang.String astrShortdescription)
          Sets the language dependent short description of the catalog entry.
 void setStartDate(java.sql.Timestamp atmstartDate)
          Sets the start date the catalog entry will be offered.
 void setThumbnail(java.lang.String astrThumbnail)
          Sets the path of the thumbnail image of the catalog entry.
 void setURL(java.lang.String astrURL)
          Sets the redirect URL.
 void setXMLdetail(java.lang.String astrXMLdetail)
          Sets the XML detail of the catalog entry.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, 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, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

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

CLASSNAME

public 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

public 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

public 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

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

setAvailable

public 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

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

getPartnumber

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

setBuyable

public void setBuyable(java.lang.Integer anBuyable)
Whether you can purchase the catalog entry:
Parameters:
anBuyable - the buyable option of the catalog entry

setCatalogId

public 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

public 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

public 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

public 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:
Parameters:
astrCatenttypeId - the catalog entry type ID

setCatEntURL

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

setCatgroupId

public 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

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

setEndDate

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

setExpirationdate

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

setField1

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

setField2

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

setField3

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

setField4

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

setField5

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

setFullimage

public 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

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

setLongdescription

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

setMarkfordelete

public void setMarkfordelete(java.lang.Integer anMarkfordelete)
Sets the mark for delete flag for the catalog entry:
Parameters:
anMarkfordelete - the mark for delete status of the catalog entry

setMemberId

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

setMfname

public 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

public 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

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

setOnauction

public void setOnauction(java.lang.Integer anOnauction)
Sets whether or not the catalog entry is on auction:
Parameters:
anOnauction - the auction flag of the catalog entry

setOnspecial

public void setOnspecial(java.lang.Integer anOnspecial)
Sets whether or not the catalog entry is on special:
Parameters:
anOnspecial - the special status flag for the catalog entry

setPartnumber

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

setPublished

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

setShortdescription

public 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

public void setStartDate(java.sql.Timestamp atmstartDate)
Sets the start date the catalog entry will be offered.

setThumbnail

public 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

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

setXMLdetail

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

setSequenceForCatgpenrel

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

setSequenceForCatentrel

public void setSequenceForCatentrel(java.lang.Double adSequenceForCatentrel)
Sets the sequence number for the catalog, catalog group, and catalog entry relationship.

getCatalogId

public 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

public 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

public 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