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:
- The first method is to provide the primary key
(CategoryId) of the Category. If the CategoryId is not known, the second or third
method can be used to uniquely identify a Category.
- The second method is to provide the
external Identifier of the Category and a MemberId that indicates the owner of the
Category. This MemberId-Identifier pair uniquely identifies exactly one Category.
- The third method is to simply provide the external Identifier without supplying a
MemberId. If this method is used, the command assumes that the owning member of the current
store is also the owner of the Category, so this MemberId along with the provided
Identifer is used to identify the Category.
Similarly, the Catalog in which the Category resides can also be specified in three ways:
- The first method is to provide the primary key (CatalogId) of the Catalog. If the
CatalogId is not known, the second or third method can be used.
- The second method is
to provide the external CatalogIdentifier of the Catalog and a CatalogMemberId that
indicates the owner of the Catalog. This CatalogMemberId-CatalogIdentifier pair
uniquely identifies exactly one Catalog.
- The third method is to simply provide the external
CatalogIdentifier without supplying a CatalogMemberId. If this method is used, the
command assumes that the owning member of the current store is also the owner of the Catalog, so this
CatalogMemberId along with the provided CatalogIdentifer is used to identify the
Catalog.
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.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
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".
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