Package com.broadleafcommerce.catalog.domain.category.commerce

Class CategoryDetails

java.lang.Object
com.broadleafcommerce.catalog.domain.category.commerce.CategoryDetails
All Implemented Interfaces:
Serializable
public class CategoryDetails extends Object implements Serializable
A structure containing all the info necessary for a category details page or section shown in a commerce-facing app (as opposed to a PIM UI).
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Details

  • Method Details

    • getMetaDescription

      public String getMetaDescription()
      Used for SEO data in <meta description=""> in a category detail page. If this is unset, getDescription() is delegated to.
      Returns:
      the meta description used for SEO data in category details page description

    • getMetaTitle

      public String getMetaTitle()
      Used for SEO data in <title> tag in a category detail page. If this is unset, getName() is delegated to.
      Returns:
      the meta title used for SEO data in category details page title

    • getCategory

      public Category getCategory()

    • getAssets

      public List<CategoryAsset> getAssets()
      All of the category's assets.
      Returns:
      All of the category's assets.

    • getBreadcrumbs

      public List<Breadcrumb> getBreadcrumbs()
      Navigational Breadcrumbs to show on the details view.
      Returns:
      Navigational Breadcrumbs to show on the details view.

    • getProducts

      public org.springframework.data.domain.Page<ProductSummary> getProducts()
      A page of Products belonging to the category. To configure the page pass paging params to the CategoryDetailsEndpoint—they will be added to the CategoryDetailsRequest.
      Returns:
      A page of Products belonging to the category.

    • getPromotionalProducts

      public Map<String,List<PromotionalCategoryProductSummary>> getPromotionalProducts()
      A map containing a category's PromotionalProducts where the key is the type.
      Returns:
      A map containing a category's PromotionalProducts where the key is the type.

    • setCategory

      public void setCategory(Category category)

    • setAssets

      public void setAssets(List<CategoryAsset> assets)
      All of the category's assets.
      Parameters:
      assets - All of the category's assets.

    • setBreadcrumbs

      public void setBreadcrumbs(List<Breadcrumb> breadcrumbs)
      Navigational Breadcrumbs to show on the details view.
      Parameters:
      breadcrumbs - Navigational Breadcrumbs to show on the details view.

    • setProducts

      public void setProducts(org.springframework.data.domain.Page<ProductSummary> products)
      A page of Products belonging to the category. To configure the page pass paging params to the CategoryDetailsEndpoint—they will be added to the CategoryDetailsRequest.
      Parameters:
      products - A page of Products belonging to the category.

    • setPromotionalProducts

      public void setPromotionalProducts(Map<String,List<PromotionalCategoryProductSummary>> promotionalProducts)
      A map containing a category's PromotionalProducts where the key is the type.
      Parameters:
      promotionalProducts - A map containing a category's PromotionalProducts where the key is the type.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getId

      public String getId()

    • getName

      public String getName()

    • getUrl

      public String getUrl()

    • getExternalId

      public String getExternalId()

    • getDescription

      public String getDescription()

    • getTaxCode

      public String getTaxCode()

    • getActiveStartDate

      public Instant getActiveStartDate()

    • getActiveEndDate

      public Instant getActiveEndDate()

    • getDisplayTemplate

      public String getDisplayTemplate()

    • getParentCategory

      public CategoryRef getParentCategory()

    • getProductMembershipType

      public String getProductMembershipType()

    • getProductMembershipRule

      public String getProductMembershipRule()

    • getProductMembershipLocale

      public Locale getProductMembershipLocale()

    • isShowInSiteMap

      public boolean isShowInSiteMap()

    • getAttributes

      public Map<String,Attribute> getAttributes()

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()

    • setId

      public void setId(String id)

    • setName

      public void setName(String name)

    • setUrl

      public void setUrl(String url)

    • setExternalId

      public void setExternalId(String externalId)

    • setDescription

      public void setDescription(String description)

    • setTaxCode

      public void setTaxCode(String taxCode)

    • setActiveStartDate

      public void setActiveStartDate(Instant activeStartDate)

    • setActiveEndDate

      public void setActiveEndDate(Instant activeEndDate)

    • setDisplayTemplate

      public void setDisplayTemplate(String displayTemplate)

    • setMetaTitle

      public void setMetaTitle(String metaTitle)

    • setMetaDescription

      public void setMetaDescription(String metaDescription)

    • setParentCategory

      public void setParentCategory(CategoryRef parentCategory)

    • setProductMembershipType

      public void setProductMembershipType(String productMembershipType)

    • setProductMembershipRule

      public void setProductMembershipRule(String productMembershipRule)

    • setProductMembershipLocale

      public void setProductMembershipLocale(Locale productMembershipLocale)

    • setShowInSiteMap

      public void setShowInSiteMap(boolean showInSiteMap)

    • setAttributes

      public void setAttributes(Map<String,Attribute> attributes)

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)