com.ibm.commerce.catalog.commands

Class TopCategoriesDisplayCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmdImpl

All Implemented Interfaces:

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

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

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.catalog.commands.TopCategoriesDisplayCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
TopCategoriesDisplayCmdImpl() No value constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isGeneric() This method determines whether this is a generic command.
boolean	isReadyToCallExecute() This method is called by the targetable command framework.
void	performExecute() This method performs the business logic for this command.
boolean	performSecurityCheck() Indicates that a user has authority to access this command.
void	reset() This method is called after a command has been executed.
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) This method sets the requestProperties for the command.
void	validateParameters() This method 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, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, 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, setCommandContext, setCommandIfName, setCommandStoreId, 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.

See Also:

Constant Field Values

Constructor Detail

TopCategoriesDisplayCmdImpl

public TopCategoriesDisplayCmdImpl()

No value constructor.

Method Detail

isGeneric

public boolean isGeneric()

Description copied from class: ControllerCommandImpl

This method determines whether 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:

This method returns true if this command can be called by a generic user and false otherwise.

isReadyToCallExecute

public boolean isReadyToCallExecute()

Description copied from class: AbstractECTargetableCommand

This method is called by the targetable command framework. This is where client side parameter checking is performed (before the execution of the command). The default implementation is to return true.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

This method returns a boolean value; true if we can execute the command and false otherwise. This default implementation will return true.

performExecute

public void performExecute()
                    throws ECException

Description copied from class: AbstractECTargetableCommand

This method performs the business logic for this command. This method should be overwritten by all command writers. Command writers should call super.performExecute() as the first line in their method.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

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 is called after a command has been executed. It is used to reset its states variables. After the call to reset, the command should be able to be executed again.

Specified by:

reset in interface com.ibm.websphere.command.Command

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 The catalog ID.

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 The member ID of the owner.

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

Description copied from class: ControllerCommandImpl

This method sets the requestProperties for the command. The WebController calls the setRequestProperties method before invoking the execute method for this command. It is the responsibility of the command writer to extract the required input parameters from the requestProperties object.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqParms - This is an object that represents the request properties.

Throws:

ECApplicationException

validateParameters

public void validateParameters()
                        throws ECException

Description copied from class: AbstractECTargetableCommand

This method performs server side parameter checking. This method replaces the checkParameters() method from version 5.1. The default implementation of validateParameters() is a no op. It is the responsibility of the command writers to implement this method if they want to perform server side parameter checking.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException