com.ibm.commerce.catalog.commands

Interface CategoryDisplayCmd

  • 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:
    CategoryDisplayCmdImpl


    public interface CategoryDisplayCmd
    extends ControllerCommand
    This command retrieves 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. The default implementation retrieves the display page name from the DISPCGPREL database table. The page name is determined by the following criteria:
    • The current category's id
    • The current user's member group
    • The current language
    • The current store
    • The type of device from which the user is accessing the page
    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.
    • 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.CategoryDisplayCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.catalog.commands.CategoryDisplayCmdImpl"
        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 from which the CategoryView is to be retrieved.
        Parameters:
        anCatalogId - the primary key of the catalog
      • setCatalogIdentifier

        void setCatalogIdentifier(java.lang.String astrCatalogIdentifier)
        Sets the external Catalog Identifier that along with the CatalogMemberId uniquely identifies the Catalog from which the CategoryView is to be retrieved.
        Parameters:
        astrCatalogIdentifier - the external identifier of the catalog
      • setCatalogMemberId

        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.
        Parameters:
        anCatalogMemberId - the primary key of the member that owns the catalog
      • setCategoryId

        void setCategoryId(java.lang.Long anCategoryId)
        Sets the CategoryId that represents the primary key of the Category whose view is to be retrieved.
        Parameters:
        anCategoryId - the primary key of the category
      • setIdentifier

        void setIdentifier(java.lang.String astrId)
        Sets the external Identifier that along with the MemberId uniquely identifies the Category whose view is to be retrieved.
        Parameters:
        astrId - the external identifier of the category
      • setMemberId

        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.
        Parameters:
        anMemberId - the primary key of the member that owns the category