com.ibm.commerce.catalog.commands
Interface CategoryDisplayCmd

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

public interface CategoryDisplayCmd
extends ControllerCommand

The purpose of this command is to retreive the configured Display Page for the specified Category in the specified catalog which will in turn be launched to display the Category information. Categories can be identified in three ways:

Similarly, the Catalog in which the Category resides can also 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.CategoryDisplayCmdImpl"
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.catalog.commands.CategoryDisplayCmd".
 
Method Summary
 void setCatalogId(java.lang.Long anCatalogId)
          Sets the CatalogId that represents the primary key of the Catalog from within which the CategoryView is to be retrieved
 void setCatalogIdentifier(java.lang.String astrCatalogIdentifier)
          Sets the external Catalog Identifier that along with the CatalogMemberId uniquely identifies the the Catalog from within which the CategoryView is to be retrieved
 void setCatalogMemberId(java.lang.Long anCatalogMemberId)
          Sets the CatalogMemberId (or owner) that along with the Catalog Identifier uniquely identifies the Catalog from within which the CategoryView is to be retrieved
 void setCategoryId(java.lang.Long anCategoryId)
          Sets the CategoryId that represents the primary key of the Category whose view is to be retrieved.
 void setIdentifier(java.lang.String astrId)
          Sets the external Identifier that along with the MemberId uniquely identifies the Category whose view is to be retrieved.
 void setMemberId(java.lang.Long anMemberId)
          Sets the MemberId (or owner) that along with the Identifier uniquely identifies the Category whose view is to be retrieved.
 
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.CategoryDisplayCmdImpl"

NAME

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

setCatalogId

public void setCatalogId(java.lang.Long anCatalogId)
Sets the CatalogId that represents the primary key of the Catalog from within which the CategoryView is to be retrieved
Parameters:
anCatalogId - java.lang.Long

setCatalogIdentifier

public void setCatalogIdentifier(java.lang.String astrCatalogIdentifier)
Sets the external Catalog Identifier that along with the CatalogMemberId uniquely identifies the the Catalog from within which the CategoryView is to be retrieved
Parameters:
astrCatalogIdentifier - java.lang.String

setCatalogMemberId

public void setCatalogMemberId(java.lang.Long anCatalogMemberId)
Sets the CatalogMemberId (or owner) that along with the Catalog Identifier uniquely identifies the Catalog from within which the CategoryView is to be retrieved
Parameters:
anCatalogMemberId - java.jang.Long

setCategoryId

public void setCategoryId(java.lang.Long anCategoryId)
Sets the CategoryId that represents the primary key of the Category whose view is to be retrieved.
Parameters:
anCategoryId - java.lang.Long

setIdentifier

public void setIdentifier(java.lang.String astrId)
Sets the external Identifier that along with the MemberId uniquely identifies the Category whose view is to be retrieved.
Parameters:
astrId - java.lang.String

setMemberId

public void setMemberId(java.lang.Long anMemberId)
Sets the MemberId (or owner) that along with the Identifier uniquely identifies the Category whose view is to be retrieved.
Parameters:
anMemberId - java.jang.Long