com.ibm.commerce.catalog.commands
Interface TopCategoriesDisplayCmd

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

public interface TopCategoriesDisplayCmd
extends ControllerCommand

The purpose of this command is to set the view task that will display the root Categories in a specified Catalog. Catalogs can be specified in three ways:


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmd".
 
Method Summary
 void setCatalogId(java.lang.Long anCatalogId)
          Sets the CatalogId that represents the primary key of the Catalog whose root Categories are to be viewed.
 void setIdentifier(java.lang.String astrIdentifier)
          Sets the external Identifier that along with the MemberId uniquely identifies the Catalog whose root Categories are to be viewed.
 void setMemberId(java.lang.Long anMemberId)
          Sets the MemberId (or owner) that along with the Identifier uniquely identifies the Catalog whose root Categories are to be viewed.
 
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

COPYRIGHT

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

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmdImpl".

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmd".
Method Detail

setCatalogId

public void setCatalogId(java.lang.Long anCatalogId)
Sets the CatalogId that represents the primary key of the Catalog whose root Categories are to be viewed.
Parameters:
anCatalogId - java.lang.Long

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)
Sets the external Identifier that along with the MemberId uniquely identifies the Catalog whose root Categories are to be viewed.
Parameters:
astrIdentifier - java.lang.String

setMemberId

public void setMemberId(java.lang.Long anMemberId)
Sets the MemberId (or owner) that along with the Identifier uniquely identifies the Catalog whose root Categories are to be viewed.
Parameters:
anMemberId - java.jang.Long