com.ibm.commerce.tools.catalog.util
Class CategoryHelper

java.lang.Object
  com.ibm.commerce.tools.catalog.util.CategoryHelper

public class CategoryHelper
extends java.lang.Object

CategoryHelper can be used to create/update/delete categories.


Constructor Summary
CategoryHelper()
Method Summary
void addCategory(CommandContext cmdContext)
Adds a category
void deleteCategory(java.lang.Long nCatalogId, java.lang.Long nCatgroupId, CommandContext cmdContext)
Delete a category
boolean getAllowDuplicatedName()
Get Allow duplicate name
java.lang.Long getCatalogId()
Get Catalog Id
java.lang.Long getCatgroupId()
Get the Catalog Group Id
java.lang.Long getCatgroupIdParent()
Get parent Catalog Group Id
CommandContext getCommandContext()
Get command context.
void reset()
resets all instance variables to null.
void setAllowDuplicatedName(boolean aboolAllowDuplicatedName)
Set Allow duplicate name
void setCatalogId(java.lang.Long anCatalogId)
Set Catalog Id
void setCatgroupId(java.lang.Long anCatgroupId)
Set Catalog Group Id
void setCatgroupIdParent(java.lang.Long anCatgroupIdParent)
Set parent Catalog Group Id
void setDescLanguage(java.lang.Integer anDescLanguage)
Set language id of Catalog Group Description
void setDisplay(java.lang.String astrDisplay)
Set Display for the Catalog Group Description
void setField1(java.lang.String astrField1)
Set Field1 of the Catalog Group
void setField2(java.lang.String astrField2)
Set Field2 of the Catalog Group
void setForContract(boolean bContract)
Set the 'UsedForContract' flag
void setFullimage(java.lang.String astrFullimage)
Set path of the full image of Catalog Group Description
void setIdentifier(java.lang.String astrIdentifier)
Set identifier of the Catalog Group
void setLongdescription(java.lang.String astrLongdescription)
Set long description of Catalog Group Description
void setMarkfordelete(java.lang.Integer anMarkfordelete)
Set markfordelete of the Catalog Group
void setName(java.lang.String astrName)
Set language dependent name of Catalog Group Description
void setPublished(java.lang.Integer anPublished)
Set published of Catalog Group Description
void setShortdescription(java.lang.String astrShortdescription)
Set short description of Catalog Group Description
void setThumbnail(java.lang.String astrThumbnail)
Set path to a thumbnail image of Catalog Group Description
void setUpdateParentCategory(boolean bUpdate)
Set the 'UpdateParentCategory' flag
void updateCategory(CommandContext cmdContext)
Update a category
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategoryHelper

public CategoryHelper()
Method Detail

addCategory

public void addCategory(CommandContext cmdContext)
                 throws ECException,
                        javax.ejb.CreateException,
                        javax.ejb.FinderException,
                        javax.ejb.RemoveException,
                        javax.naming.NamingException,
                        java.rmi.RemoteException,
                        CatalogToolException
Adds a category
Throws:
ECException
javax.ejb.CreateException
javax.ejb.FinderException
javax.ejb.RemoveException
javax.naming.NamingException
java.rmi.RemoteException
CatalogToolException

deleteCategory

public void deleteCategory(java.lang.Long nCatalogId,
                           java.lang.Long nCatgroupId,
                           CommandContext cmdContext)
                    throws ECException,
                           javax.ejb.CreateException,
                           javax.ejb.FinderException,
                           javax.ejb.RemoveException,
                           javax.naming.NamingException,
                           java.rmi.RemoteException,
                           CatalogToolException
Delete a category
Throws:
ECException
javax.ejb.CreateException
javax.ejb.FinderException
javax.ejb.RemoveException
javax.naming.NamingException
java.rmi.RemoteException
CatalogToolException

getCatalogId

public java.lang.Long getCatalogId()
Get Catalog Id

getCatgroupId

public java.lang.Long getCatgroupId()
Get the Catalog Group Id

getCatgroupIdParent

public java.lang.Long getCatgroupIdParent()
Get parent Catalog Group Id

getCommandContext

public CommandContext getCommandContext()
Get command context.

getAllowDuplicatedName

public boolean getAllowDuplicatedName()
Get Allow duplicate name
Returns:
true if duplicate names are allowed, otherwise false

reset

public void reset()
resets all instance variables to null.

setAllowDuplicatedName

public void setAllowDuplicatedName(boolean aboolAllowDuplicatedName)
Set Allow duplicate name

setCatalogId

public void setCatalogId(java.lang.Long anCatalogId)
Set Catalog Id

setCatgroupId

public void setCatgroupId(java.lang.Long anCatgroupId)
Set Catalog Group Id

setCatgroupIdParent

public void setCatgroupIdParent(java.lang.Long anCatgroupIdParent)
Set parent Catalog Group Id

setDescLanguage

public void setDescLanguage(java.lang.Integer anDescLanguage)
                     throws ECException
Set language id of Catalog Group Description
Throws:
ECException

setDisplay

public void setDisplay(java.lang.String astrDisplay)
Set Display for the Catalog Group Description

setField1

public void setField1(java.lang.String astrField1)
Set Field1 of the Catalog Group

setField2

public void setField2(java.lang.String astrField2)
Set Field2 of the Catalog Group

setForContract

public void setForContract(boolean bContract)
Set the 'UsedForContract' flag

setFullimage

public void setFullimage(java.lang.String astrFullimage)
Set path of the full image of Catalog Group Description

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)
Set identifier of the Catalog Group

setLongdescription

public void setLongdescription(java.lang.String astrLongdescription)
Set long description of Catalog Group Description

setMarkfordelete

public void setMarkfordelete(java.lang.Integer anMarkfordelete)
Set markfordelete of the Catalog Group

setName

public void setName(java.lang.String astrName)
Set language dependent name of Catalog Group Description

setPublished

public void setPublished(java.lang.Integer anPublished)
Set published of Catalog Group Description

setShortdescription

public void setShortdescription(java.lang.String astrShortdescription)
Set short description of Catalog Group Description

setThumbnail

public void setThumbnail(java.lang.String astrThumbnail)
Set path to a thumbnail image of Catalog Group Description

setUpdateParentCategory

public void setUpdateParentCategory(boolean bUpdate)
Set the 'UpdateParentCategory' flag

updateCategory

public void updateCategory(CommandContext cmdContext)
                    throws ECException,
                           javax.ejb.CreateException,
                           javax.ejb.FinderException,
                           javax.ejb.RemoveException,
                           javax.naming.NamingException,
                           java.rmi.RemoteException,
                           CatalogToolException
Update a category
Throws:
ECException
javax.ejb.CreateException
javax.ejb.FinderException
javax.ejb.RemoveException
javax.naming.NamingException
java.rmi.RemoteException
CatalogToolException

Feedback