Class ComposeCatalogGroupSummaryTaskCmdImpl

  • java.lang.Object
  • All Implemented Interfaces:

    public class ComposeCatalogGroupSummaryTaskCmdImpl
    extends java.lang.Object
    implements ComposeCatalogGroupTaskCmd
    This class is used to compose the summary of a category. This Class composes the category information based on the category summary access profile. The category details included in this access profile include, the CategoryId, Category name, thumbnail image location and the short description of the category. To get these details, set the category data bean using,setCatalogGroups(), and call the execute(). The details will be in the CatalogGroupType object, which can be obtained by getCatalogGroup().
    See Also:
    Serialized Form
    • Field Detail


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

      • ComposeCatalogGroupSummaryTaskCmdImpl

        public ComposeCatalogGroupSummaryTaskCmdImpl()
        The default constructor for the class.
    • Method Detail

      • execute

        public void execute()
        Composes a summary of the category. This method is used to compose a summary of the category. The information included are CategoryId, Category name, thumbnail image location and the short description of the category. The details returned by this command include
        • /CatalogGroup/CatalogGroupIdentifier/UniqueID
        • /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
        • /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier
        • /CatalogGroup/Description(@language)/Name
        • /CatalogGroup/Description(@language /ThumbNail
        • /CatalogGroup/Description(@language /ShortDescription
        Specified by:
        execute in interface
        Throws: - when the required information could not extracted from the data bean.
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Checks if the category data bean required to extract the information is set.
        Specified by:
        isReadyToCallExecute in interface
        true if ready, false otherwise.
      • reset

        public void reset()
        Resets the value of the category data bean to null.
        Specified by:
        reset in interface
      • setCatalogGroupDataBean

        public void setCatalogGroupDataBean(CategoryDataBean catgrpDataBean)
        catgrpDataBean - the CategoryDatabean to be used for the compose.
      • setPagingParams

        public void setPagingParams(java.math.BigInteger begIndex,
                                    java.math.BigInteger dispNum)
        Paging is not supported for this command. The parameters passed will be ignored for this command.
        Specified by:
        setPagingParams in interface ComposeCatalogGroupTaskCmd
        begIndex - the begging index.
        dispNum - the page size.