Package com.broadleafcommerce.data.tracking.core.filtering.domain

Interface CatalogInfo

public interface CatalogInfo
Partially de-normalized representation of a multitenant catalog. Generally used during fetch queries to discriminate results based on what is visible to the current application context. See ContextRequest.
Author:
Jeff Fischer, Samarth Dhruva (samarthd)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContextId()
    A soft reference for the catalog id.
    Long
    getLevel()
    Sorting level used to determine closest catalog visibility to the caller's context
    Locale
    getLocale()
    Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
    String
    getName()
    The catalog's name.
    default String
    getOriginatingCatalogId()
    A soft reference for the catalog that owns the entity from which this override is derived.
    CatalogBasicInfo
    getParent()
    A soft reference for the catalog from whom an implicit catalog is derived.
    void
    setContextId(String contextId)
    A soft reference for the catalog id.
    void
    setLevel(Long level)
    Sorting level used to determine closest catalog visibility to the caller's context
    void
    setLocale(Locale locale)
    Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
    void
    setName(String name)
    The catalog's name.
    default void
    setOriginatingCatalogId(String catalogId)
    A soft reference for the catalog that owns the entity from which this override is derived.
    void
    setParent(CatalogBasicInfo parent)
    A soft reference for the catalog from whom an implicit catalog is derived.

  • Method Details

    • getContextId

      String getContextId()
      A soft reference for the catalog id. Multitenant hierarchies for applications and catalogs are maintained separately in the multitenant microservice.
      Returns:
      The soft reference to the catalog id

    • setContextId

      void setContextId(String contextId)
      A soft reference for the catalog id. Multitenant hierarchies for applications and catalogs are maintained separately in the multitenant microservice.
      Parameters:
      contextId - The soft reference to the catalog id

    • getName

      String getName()
      The catalog's name.
      Returns:
      the name of the catalog

    • setName

      void setName(String name)
      The catalog's name.
      Parameters:
      name - the name of the catalog

    • getLocale

      Locale getLocale()
      Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
      Returns:
      the Locale that all items within this catalog apply to

    • setLocale

      void setLocale(Locale locale)
      Locale information for the catalog, which encodes the assumption of the defaulted region for all items contained within it.
      Parameters:
      locale - the Locale that all items within this catalog apply to

    • getLevel

      Long getLevel()
      Sorting level used to determine closest catalog visibility to the caller's context
      Returns:
      Sorting level

    • setLevel

      void setLevel(Long level)
      Sorting level used to determine closest catalog visibility to the caller's context
      Parameters:
      level - Sorting level

    • getParent

      CatalogBasicInfo getParent()
      A soft reference for the catalog from whom an implicit catalog is derived. Implicit catalogs are related to Application instances and are a home to any overrides of catalog related information inherited by that application from its assigned catalogs. This value will be null unless getContextId() references an implicit catalog.
      Returns:
      A soft reference for the catalog from whom an implicit catalog is derived

    • setParent

      void setParent(CatalogBasicInfo parent)
      A soft reference for the catalog from whom an implicit catalog is derived. Implicit catalogs are related to Application instances and are a home to any overrides of catalog related information inherited by that application from its assigned catalogs. This value will be null unless getContextId() references an implicit catalog.
      Parameters:
      parent - A soft reference for the catalog from whom an implicit catalog is derived

    • getOriginatingCatalogId

      default String getOriginatingCatalogId()
      A soft reference for the catalog that owns the entity from which this override is derived. This is only set in the case that the entity is a catalog override, and is null otherwise. This value is also not persisted and is only set after the mapping pipeline has examined a request for persistence. Use with caution.
      Returns:
      A soft reference for the catalog that owns the entity from which this override is derived

    • setOriginatingCatalogId

      default void setOriginatingCatalogId(String catalogId)
      A soft reference for the catalog that owns the entity from which this override is derived. This is only set in the case that the entity is a catalog override, and is null otherwise. This value is also not persisted and is only set after the mapping pipeline has examined a request for persistence. Use with caution.
      Parameters:
      catalogId - A soft reference for the catalog that owns the entity from which this override is derived