com.ibm.commerce.catalog.facade.server.commands

Class ComposeCatalogDetailsTaskCmdImpl

  • java.lang.Object
    • com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogDetailsTaskCmdImpl
  • All Implemented Interfaces:
    ComposeCatalogTaskCmd, com.ibm.websphere.command.Command, java.io.Serializable

    public class ComposeCatalogDetailsTaskCmdImpl
extends java.lang.Object
implements ComposeCatalogTaskCmd
    This command composes the Catalog details. This command is used to get the Catalog related information. The information returned is according to the WC_CatalogDetailsProfile. The values corresponding to this access profile are as per the following Xpath,
    • /Catalog(@primary)
    • /Catalog/CatalogIdentifier//UniqueID
    • /Catalog/CatalogIdentifier/ExternalIdentifier(@ownerID)
    • /Catalog/CatalogIdentifier/ExternalIdentifier(@ownerID)/Identifier
    • /Catalog/CatalogDescription(@language)/Name
    • /Catalog/CatalogDescription(@language)/ThumbNail
    • /Catalog/CatalogDescription(@language)/FullImage
    • /Catalog/CatalogDescription(@language)/ShortDescription
    • /Catalog/CatalogDescription(@language)/LongDescription
        • To get these details, set the catalog data bean using,setCatalogs(), and call the execute(). The details will be in the CatalogType object, which can be obtained by getCatalogGroup().
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

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

        serialVersionUID

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void execute()
      This method composes the ShowCatalog BOD.
      CatalogType getCatalog()
      Return the ShowCatalog BOD.
      boolean isReadyToCallExecute()
      This method checks if the catalog data bean required to return the catalog information has been set.
      void reset()
      This method resets the catalog data bean used in the command to null.
      void setCatalogs(java.util.ArrayList avCatalogs)
      Set the input list of catalogs.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • ComposeCatalogDetailsTaskCmdImpl

        public ComposeCatalogDetailsTaskCmdImpl()
        The default constructor for the class.

    • Method Detail

      • setCatalogs

        public void setCatalogs(java.util.ArrayList avCatalogs)
        Description copied from interface: ComposeCatalogTaskCmd
        Set the input list of catalogs.
        Specified by:
        setCatalogs in interface ComposeCatalogTaskCmd
        Parameters:
        avCatalogs - - A list of Catalog data bean.

      • execute

        public void execute()
             throws com.ibm.websphere.command.CommandException
        This method composes the ShowCatalog BOD. This method gets the relevant information about the catalog from the CatalogDataBean.The information is according to the output definition of WC_CatalogDetailsProfile access profile.The following details are included in this access profile. The details returned for the catalog include,
        • /Catalog(@primary)
        • /Catalog/CatalogIdentifier//UniqueID
        • /Catalog/CatalogIdentifier/ExternalIdentifier(@ownerID)
        • /Catalog/CatalogIdentifier/ExternalIdentifier(@ownerID)/Identifier
        • /Catalog/CatalogDescription(@language)/Name
        • /Catalog/CatalogDescription(@language)/ThumbNail
        • /Catalog/CatalogDescription(@language)/FullImage
        • /Catalog/CatalogDescription(@language)/ShortDescription
        • /Catalog/CatalogDescription(@language)/LongDescription
          Specified by:
          execute in interface com.ibm.websphere.command.Command
          Throws:
          com.ibm.websphere.command.CommandException - when the required information cannot be retrieved from the catalog data bean.

        • isReadyToCallExecute

          public boolean isReadyToCallExecute()
          This method checks if the catalog data bean required to return the catalog information has been set.
          Specified by:
          isReadyToCallExecute in interface com.ibm.websphere.command.Command
          Returns:
          true if ready, false otherwise.

        • reset

          public void reset()
          This method resets the catalog data bean used in the command to null.
          Specified by:
          reset in interface com.ibm.websphere.command.Command
    Skip navigation links