com.ibm.commerce.catalog.commands

Interface ProductDisplayCmd

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


    public interface ProductDisplayCmd
    extends ControllerCommand
    This command retrieves the configured Display Page for the specified CatalogEntry which will in turn be launched in order to display information about the CatalogEntry. The default implementation retrieves the display page name from the DISPENTREL table. The page name is determined by the following criteria:
    • The current catalog entry's id
    • The current user's member group
    • The current language
    • The current store
    • The CatalogEntry type
    • The type of device from which the user is accessing the page
    • Whether or not this CatalogEntry is currently on auction
    The type of the CatalogEntry may be Catalog Item, Product with defining attributes, Bundle, Static Kit or Dynamic Kit.
    CatalogEntries can be specified in three ways:
    • The first method is to provide the primary key (ProductId) of the CatalogEntry. If the ProductId is not known, the second or third method can be used to uniquely identify a CatalogEntry.
    • The second method is to provide the external PartNumber of the CatalogEntry and a MemberId that indicates its owner. This MemberId-PartNumber pair uniquely identifies exactly one CatalogEntry.
    • The third method is to simply provide the external PartNumber 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 CatalogEntry. Therefore, this MemberId along with the provided PartNumber are used to identify the CatalogEntry.
    • 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.ProductDisplayCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.catalog.commands.ProductDisplayCmdImpl".
        See Also:
        Constant Field Values
    • Method Detail

      • setMemberId

        void setMemberId(java.lang.Long anMemberId)
        Sets the MemberId (or owner) that along with the PartNumber uniquely identifies the CatalogEntry whose view is to be retrieved.
        Parameters:
        anMemberId - the primary key of the member that owns the catalog entry
      • setPartNumber

        void setPartNumber(java.lang.String astrPartNumber)
        Sets the external PartNumber that along with the MemberId uniquely identifies the CatalogEntry whose view is to be retrieved.
        Parameters:
        astrPartNumber - the external identifier of the catalog entry
      • setProductId

        void setProductId(java.lang.Long anProductId)
        Sets the ProductId that represents the primary key of the CatalogEntry whose view is to be retrieved.
        Parameters:
        anProductId - the primary key of the catalog entry