com.ibm.commerce.catalogmanagement.commands
Interface CatalogGroupAddCmd

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

public interface CatalogGroupAddCmd
extends ControllerCommand

The CatalogGroupAddCmd is a URL and controller command that:

Parameters: Access Beans: Task Commands: Other Controller Commands: 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 Summary
static java.lang.String CLASSNAME
          Defines the CLASSNAME.
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.Long getCatgroupId()
          Gets the catalog group ID.
 java.lang.String getIdentifier()
          Gets the catalog group identifier.
 void setCatalogId(java.lang.Long anCatalogId)
          Sets the catalog ID.
 void setCatgroupId(java.lang.Long anCatgroupId)
          Sets the catalog group ID for the description.
 void setCatgroupIdParent(java.lang.Long anCatgroupIdParent)
          Sets the parent catalog group ID for the catalog, parent catalog group, and child catalog group relationship.
 void setDescLanguage(java.lang.Integer anDescLang)
          Sets the language ID for the catalog group description.
 void setDisplay(java.lang.String astrDisplay)
          Sets the display for the catalog group.
 void setField1(java.lang.String astrField1)
          Sets the field 1 in the catalog group description.
 void setField2(java.lang.String astrField2)
          Sets the field 2 in the catalog group description.
 void setFullimage(java.lang.String astrFullimage)
          Sets the path of the full image of catalog group.
 void setIdentifier(java.lang.String astrIdentifier)
          Sets the catalog group identifier.
 void setKeyword(java.lang.String astrKeyword)
          Sets the language dependent keyword for the catalog group.
 void setLastupdate(java.sql.Timestamp atmLastupdate)
          Sets the date and time when the catalog group was updated.
 void setLongdescription(java.lang.String astrLongdescription)
          Sets the long description of the catalog group.
 void setMarkfordelete(java.lang.Integer anMarkfordelete)
          Sets the mark for delete flag for the catalog group: 1 = marked for delete.
 void setMemberId(java.lang.Long anMemberId)
          Sets the owner ID of the catalog group.
 void setName(java.lang.String astrName)
          Sets the language dependent name of the catalog group.
 void setOID(java.lang.String astrOID)
          Sets the object identifier of the catalog group.
 void setPublished(java.lang.Integer anPublished)
          Sets whether the catalog group should be displayed in the specified language.
 void setSequenceForCatgrprel(java.lang.Double adSequenceForCatgrprel)
          Sets the sequence number for the catalog, parent catalog group, and child catalog group relationship.
 void setShortdescription(java.lang.String astrShortdescription)
          Sets the short description of the catalog group.
 void setThumbnail(java.lang.String astrThumbnail)
          Sets the path of the thumbnail image of the catalog group.
 void setURL(java.lang.String astrURL)
          Sets the redirect URL
 
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
Defines the CLASSNAME.
See Also:
Constant Field Values
Method Detail

setCatalogId

public 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

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

getIdentifier

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

setCatgroupId

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

setIdentifier

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

setCatgroupIdParent

public 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

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

setDisplay

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

setField1

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

setField2

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

setFullimage

public 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

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

setLastupdate

public 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

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

setMarkfordelete

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

setMemberId

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

setName

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

setOID

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

setPublished

public 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:
Parameters:
anPublished - the publish flag of the catalog group description in the specified language

setShortdescription

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

setThumbnail

public 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

setSequenceForCatgrprel

public 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

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