com.ibm.commerce.catalog.commands
Class TopCategoriesDisplayCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, TopCategoriesDisplayCmd

public class TopCategoriesDisplayCmdImpl
extends ControllerCommandImpl
implements TopCategoriesDisplayCmd

This command first ensures that the specified Catalog can be displayed in the current store and then sets the TopCategoriesDisplayView task.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.catalog.commands. TopCategoriesDisplayCmd
defaultCommandClassName, NAME
 
Constructor Summary
TopCategoriesDisplayCmdImpl()
          No value constructor.
 
Method Summary
protected  java.lang.Long getCatalogId()
          Returns the CatalogId that represents the primary key of the Catalog whose root Categories are to be viewed.
protected  java.lang.String getIdentifier()
          Returns the external Identifier that along with the MemberId uniquely identifies the Catalog whose root Categories are to be viewed.
protected  java.lang.Long getMemberId()
          Returns the MemberId (or owner) that along with the Identifier uniquely identifies the Catalog whose root Categories are to be viewed.
 boolean isGeneric()
          Checks if this is a generic command.
 boolean isReadyToCallExecute()
          This method is called by the Targettable Command frame work before the execution of the command.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 boolean performSecurityCheck()
          Indicates that a user has authority to access this command.
 void reset()
          This method should be called after a command has been executed to reset its states variables.
 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.
 void setRequestProperties( TypedProperty reqParms)
          Sets the request properties.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isRetriable, mergeProperties, setGeneric, 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, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values
Constructor Detail

TopCategoriesDisplayCmdImpl

public TopCategoriesDisplayCmdImpl()
No value constructor.
Method Detail

getCatalogId

protected java.lang.Long getCatalogId()
Returns the CatalogId that represents the primary key of the Catalog whose root Categories are to be viewed.
Returns:
java.lang.Long

getIdentifier

protected java.lang.String getIdentifier()
Returns the external Identifier that along with the MemberId uniquely identifies the Catalog whose root Categories are to be viewed.
Returns:
java.lang.String

getMemberId

protected java.lang.Long getMemberId()
Returns the MemberId (or owner) that along with the Identifier uniquely identifies the Catalog whose root Categories are to be viewed.
Returns:
java.jang.Long

isGeneric

public boolean isGeneric()
Description copied from interface: ControllerCommand
Checks if this is a generic command. A generic command is a command that can be invoked by a generic user. The default is false for all controller commands and true for all view commands.
Specified by:
isGeneric in interface ControllerCommand
Overrides:
isGeneric in class ControllerCommandImpl
Returns:
true if this command can be called by a generic user false if this command cannot be called by a generic user

isReadyToCallExecute

public boolean isReadyToCallExecute()
Description copied from class: AbstractECTargetableCommand
This method is called by the Targettable Command frame work before the execution of the command. The default implementation is to return true.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
ECException

performSecurityCheck

public boolean performSecurityCheck()
Indicates that a user has authority to access this command.
Returns:
boolean

reset

public void reset()
Description copied from class: AbstractECTargetableCommand
This method should be called after a command has been executed to reset its states variables. After the call to reset, we should be able to execute the command again.
Overrides:
reset in class AbstractECTargetableCommand

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.
Specified by:
setCatalogId in interface TopCategoriesDisplayCmd
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.
Specified by:
setIdentifier in interface TopCategoriesDisplayCmd
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.
Specified by:
setMemberId in interface TopCategoriesDisplayCmd
Parameters:
anMemberId - java.jang.Long

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
Description copied from interface: ControllerCommand
Sets the request properties. The WebController calls this method before invoking the execute method in this command to set the request properties for this command. It is the responsibility of the implementer of the ControllerCommand to extract the required input parameters from the request properties and perform parameter checking.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
reqParms - request properties
ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
ECException