Interface FeaturedCategoryList

  • All Superinterfaces:
    com.adobe.cq.wcm.core.components.models.Component, com.adobe.cq.export.json.ComponentExporter
    All Known Implementing Classes:
    FeaturedCategoryListImpl

    public interface FeaturedCategoryList
    extends com.adobe.cq.wcm.core.components.models.Component
    Provides the list of categories to CategoryList Componenet.
    • Field Summary

      • Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

        PN_ID
    • Method Detail

      • getCategories

        List<com.adobe.cq.commerce.magento.graphql.CategoryTree> getCategories()
        Returns the categories data in a list from Magento depending on configurations.
        Returns:
        List<CategoryInterface>
      • getCategoryItems

        List<FeaturedCategoryListItem> getCategoryItems()
        Returns a list of category identifiers configured for this component
        Returns:
        a List of CategoryListItem objects or an empty list if no categories are configured
      • getCategoriesRetriever

        AbstractCategoriesRetriever getCategoriesRetriever()
        Returns in instance of the category retriever for fetching category data via GraphQL.
        Returns:
        category retriever instance
      • isConfigured

        boolean isConfigured()
        Returns true if the component is correctly configured, false otherwise.
        Returns:
        true or false
      • getTitleType

        String getTitleType()
        Should return the HTML tag type for the component title.
        Returns:
        The HTML tag type that should be used to display the component title.