Package org.broadleafcommerce.core.web.seo

Interface SeoPropertyService

All Known Implementing Classes:
SeoPropertyServiceImpl
public interface SeoPropertyService
The SeoPropertyService is responsible for generating the appropriate properties representing the known metadata about that page.
Author:
Chris Kittrell (ckittrell)

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getSeoProperties(org.broadleafcommerce.common.page.dto.PageDTO page)
    Returns a Map<String, String> that contains the known additional attributes for the current context.
    Map<String,String>
    getSeoProperties(org.broadleafcommerce.core.catalog.domain.Category category)
    Returns a Map<String, String> that contains the known additional attributes for the current context.
    Map<String,String>
    getSeoProperties(org.broadleafcommerce.core.catalog.domain.Product product)
    Returns a Map<String, String> that contains the known additional attributes for the current context.

  • Method Details

    • getSeoProperties

      Map<String,String> getSeoProperties(org.broadleafcommerce.core.catalog.domain.Product product)
      Returns a Map<String, String> that contains the known additional attributes for the current context. This method understands how to extract additional attributes for products.

      Note that this method will extract the values of the ProductAttributes from their respective entities. It does not filter these attributes, and it is quite likely that some of these attributes will not be SEO related.

      Individual resolvers for these attributes will skip ones that do not apply.

      Parameters:
      product -
      Returns:
      the known attributes

    • getSeoProperties

      Map<String,String> getSeoProperties(org.broadleafcommerce.core.catalog.domain.Category category)
      Returns a Map<String, String> that contains the known additional attributes for the current context. This method understands how to extract additional attributes for products, categories, and pages.

      Note that this method will extract the values of the CategoryAttributes from their respective entities. It does not filter these attributes, and it is quite likely that some of these attributes will not be SEO related.

      Individual resolvers for these attributes will skip ones that do not apply.

      Parameters:
      category -
      Returns:
      the known attributes

    • getSeoProperties

      Map<String,String> getSeoProperties(org.broadleafcommerce.common.page.dto.PageDTO page)
      Returns a Map<String, String> that contains the known additional attributes for the current context. This method understands how to extract additional attributes for products, categories, and pages.

      Note that this method will extract the values of the PageAttributes from their respective entities. It does not filter these attributes, and it is quite likely that some of these attributes will not be SEO related.

      Individual resolvers for these attributes will skip ones that do not apply.

      Parameters:
      page -
      Returns:
      the known attributes