com.ibm.commerce.catalog.commands
Interface CategoryDisplayCmd

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

public interface CategoryDisplayCmd
extends ControllerCommand

This command is to retrieves 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 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 Catalog from 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
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

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.catalog.commands.CategoryDisplayCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.catalog.commands.CategoryDisplayCmdImpl"
See Also:
Constant Field Values
Method Detail

setCatalogId

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

setCatalogIdentifier

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

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 - the primary key of the member that owns the catalog

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 - the primary key of the category

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 - the external identifier of the category

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 - the primary key of the member that owns the category