com.ibm.commerce.catalog.commands

Class CategoryDisplayCmdImpl

  • All Implemented Interfaces:
    CategoryDisplayCmd, 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 CategoryDisplayCmdImpl
extends ControllerCommandImpl
implements CategoryDisplayCmd
    The purpose of this command is to retrieve the configured Display Page for the specified Category in the specified catalog. That display page 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. Therefore, this MemberId along with the provided Identifier 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. Therefore, this CatalogMemberId along with the provided CatalogIdentifer is used to identify the Catalog.
    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

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

      • PARENT_CATEGORY_ID_PARAMETER

        public static final java.lang.String PARENT_CATEGORY_ID_PARAMETER
        Constant to indicate the parent category ID parameter name. The command looks for this parameter to identify the parent category of the current category. If this parameter is not specified, the parent category is resolved.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CategoryDisplayCmdImpl

        public CategoryDisplayCmdImpl()
        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.

      • 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 from within which the CategoryView is to be retrieved
        Specified by:
        setCatalogId in interface CategoryDisplayCmd
        Parameters:
        anCatalogId - java.lang.Long The catalog ID from which the CategoryView is to be retrieved.

      • 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 The Catalog Identifier

      • 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 The Catalog Member ID

      • 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 The Category ID

      • 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:
        astrIdentifier - java.lang.String The external Identifier

      • 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 The member ID
Skip navigation links