com.ibm.commerce.catalog.commands
Class CategoryDisplayCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.catalog.commands.CategoryDisplayCmdImpl
All Implemented Interfaces:
AccCommand, CategoryDisplayCmd, ControllerCommand, ECCommand, ECTargetableCommand, Protectable

public class CategoryDisplayCmdImpl
extends ControllerCommandImpl
implements CategoryDisplayCmd

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.
protected  java.lang.Long inCategoryMemberNumber
           
protected  java.lang.Long inCategoryNumber
           
 
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.CategoryDisplayCmd
defaultCommandClassName, NAME
 
Constructor Summary
CategoryDisplayCmdImpl()
          No value constructor.
 
Method Summary
protected  java.lang.Long getCatalogId()
          Returns the CatalogId that represents the primary key of the Catalog
protected  java.lang.String getCatalogIdentifier()
          Returns the external Identifier of the Catalog.
protected  java.lang.Long getCatalogMemberId()
          Returns the MemberId that represents the primary key ofthe owner of the Catalog.
protected  java.lang.Long getCategoryId()
          Returns the CategoryId that represents the primary key of the Category
protected  java.lang.String getIdentifier()
          Returns the external Identifier of the Category.
protected  java.lang.Long getMemberId()
          Returns the MemberId that represents the primary key ofthe owner of the Category.
 boolean isGeneric()
          Check to see if this is a generic command.
 boolean isReadyToCallExecute()
          isReadyToCallExecute 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 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 astrIdentifier)
          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.
 void setRequestProperties(TypedProperty reqParms)
          The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isRetriable, mergeProperties, setGeneric, 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, setCommandContext, setCommandIfName, setDefaultProperties
 
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.

inCategoryMemberNumber

protected java.lang.Long inCategoryMemberNumber

inCategoryNumber

protected java.lang.Long inCategoryNumber
Constructor Detail

CategoryDisplayCmdImpl

public CategoryDisplayCmdImpl()
No value constructor.
Method Detail

getCatalogId

protected java.lang.Long getCatalogId()
Returns the CatalogId that represents the primary key of the Catalog
Returns:
java.lang.Long

getCatalogIdentifier

protected java.lang.String getCatalogIdentifier()
Returns the external Identifier of the Catalog.
Returns:
java.lang.String

getCatalogMemberId

protected java.lang.Long getCatalogMemberId()
Returns the MemberId that represents the primary key ofthe owner of the Catalog.
Returns:
java.lang.Long

getCategoryId

protected java.lang.Long getCategoryId()
Returns the CategoryId that represents the primary key of the Category
Returns:
java.lang.Long

getIdentifier

protected java.lang.String getIdentifier()
Returns the external Identifier of the Category.
Returns:
java.lang.String

getMemberId

protected java.lang.Long getMemberId()
Returns the MemberId that represents the primary key ofthe owner of the Category.
Returns:
java.lang.Long

isGeneric

public boolean isGeneric()
Description copied from interface: ControllerCommand
Check to see 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
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Returns:
boolean - 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
isReadyToCallExecute 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
Following copied from class: com.ibm.commerce.command.AbstractECTargetableCommand
Returns:
boolean - 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
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

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 from within which the CategoryView is to be retrieved
Specified by:
setCatalogId in interface CategoryDisplayCmd
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
Specified by:
setCatalogIdentifier in interface CategoryDisplayCmd
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
Specified by:
setCatalogMemberId in interface CategoryDisplayCmd
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.
Specified by:
setCategoryId in interface CategoryDisplayCmd
Parameters:
anCategoryId - java.lang.Long

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)
Sets the external Identifier that along with the MemberId uniquely identifies the Category whose view is to be retrieved.
Specified by:
setIdentifier in interface CategoryDisplayCmd
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.
Specified by:
setMemberId in interface CategoryDisplayCmd
Parameters:
anMemberId - java.jang.Long

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
Description copied from interface: ControllerCommand
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
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -  

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
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -