Package com.broadleafcommerce.search.api.domain

Interface CatalogTrackable

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware
public interface CatalogTrackable extends com.broadleafcommerce.data.tracking.core.ContextStateAware
Interface for objects which are trackable by catalog.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getCatalogOmissions()
    The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.
    Set<String>
    getCatalogOverrides()
    Get any catalog contexts where this trackable has been overridden.
    Set<String>
    getMarketplaceApplications()
    All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.
    void
    setCatalogOmissions(Set<String> catalogOmissions)
    The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.
    void
    setCatalogOverrides(Set<String> catalogOverrides)
    Set any catalog contexts where this trackable has been overridden.
    void
    setMarketplaceApplications(Set<String> marketplaceApplications)
    All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    getContextState, setContextState

  • Method Details

    • getCatalogOverrides

      Set<String> getCatalogOverrides()
      Get any catalog contexts where this trackable has been overridden.
      Returns:
      Catalog contexts where this trackable has been overridden

    • setCatalogOverrides

      void setCatalogOverrides(Set<String> catalogOverrides)
      Set any catalog contexts where this trackable has been overridden.
      Parameters:
      catalogOverrides - Catalog contexts where this trackable has been overridden

    • getCatalogOmissions

      Set<String> getCatalogOmissions()
      The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.

      e.g. if this product is in catalog A, and catalog B inherits this product from catalog A but contains a filter that removes it from the view of catalog B, then the catalog A version product will contain "B" in its catalogOmissions.

      Returns:
      the IDs of any descendant catalogs in which this product has been omitted.

    • setCatalogOmissions

      void setCatalogOmissions(Set<String> catalogOmissions)
      The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.

      e.g. if this product is in catalog A, and catalog B inherits this product from catalog A but contains a filter that removes it from the view of catalog B, then the catalog A version product will contain "B" in its catalogOmissions.

    • getMarketplaceApplications

      Set<String> getMarketplaceApplications()
      All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.

    • setMarketplaceApplications

      void setMarketplaceApplications(Set<String> marketplaceApplications)
      All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.