TopCategoriesDisplayCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

TopCategoriesDisplayCmdImpl
```
public interface TopCategoriesDisplayCmd
extends ControllerCommand
```
This command sets the view task that will display the root Categories in a specified Catalog. Catalogs can 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 to uniquely identify a Catalog.
- The second method is to provide the external Identifier of the Catalog and a MemberId that indicates its owner. This MemberId-Identifier pair uniquely identifies exactly one Catalog.
- 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 Catalog. Therefore, this MemberId along with the provided Identifier are used to identify the Catalog.

Field Summary

Fields
Modifier and Type	Field and Description
`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".

Fields inherited from interface com.ibm.websphere.command.Command
serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    The internal copyright field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    The name of this interface is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmd".
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The default implementation class is "com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmdImpl".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setCatalogId
```
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 - the primary key of the catalog
  - setIdentifier
```
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 - the external identifier of the catalog
  - setMemberId
```
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 - the primary key of the member that owns the catalog